Skip to main content
POST
ads.account.connect.start

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
platform
enum<string>
required

Which platform's ads to connect.

Available options:
facebook,
instagram,
linkedin,
tiktok,
x,
pinterest,
googleads
returnUrl
string
required

URL the person returns to after the sign-in. Added to its query string: status (connected, failed or pending), platform, accountId when connected, and error (plus retry=true when trying again can fix it) when failed; needsSelection and flow when the connection still needs a choice. Accepts a public URL, or http on localhost for a local install.

accountId
string

The connected posting account to run ads for, when the platform needs one named (it must be one of your own accounts, from social.accounts.list).

Required string length: 1 - 256

Response

The result

connectUrl
string

Send the person here to sign in and approve the ads connection.

ref
string

Reference to what this call created. Pass it as ref to social.account.connect.status.

connected
boolean

True when the ads account already exists and nothing needs signing in.

accountId
string

The ads account: pass it to the ads.* capabilities.

platform
string

Lowercase platform name of the ads account.

handle
string

Account handle without the @.

displayName
string

Display name.

scopedAdAccountIds
string[]

The ad accounts the connection is scoped to.