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

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 ads platform to connect by key.

Available options:
chatgpt,
whop
apiKey
string
required

The account's API key, from that platform's dashboard. Forwarded once so the platform can verify it and keep it for the connection; not stored or logged by this API, and never in a result or an error.

Required string length: 1 - 1024

Response

The result

accountId
string
required

The ads account: pass it to the ads.* capabilities and the tracking-tag routes.

platform
string
required

The platform the connection is for: the name sent.

name
string

The account's name on the platform.

externalAccountId
string

The account's own id on the platform (also the tracking-tag id, where one exists).