Skip to main content
POST
Archive a promoted ad

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

FlowAuthorization Code
Authorization URL
https://app.sideshift.app/api/oauth/v1/authorize
Token URL
https://app.sideshift.app/api/oauth/v1/token
Refresh URL
https://app.sideshift.app/api/oauth/v1/token
Scopes1
ads:write
Create and manage ad campaigns and connected ad accounts (sensitive — this can spend money)

Headers

Idempotency-Key
string

Client-chosen key; replaying the same key + body returns the original response, a different body returns 409.

Path Parameters

id
string
required

The id.

Body

application/json

The body is of type object.

Response

Success. Returns the resource envelope.

The response is of type object.