ads

POST `/v1/ads/connect/x/grants/{grant_id}`

Connect the picked X ad accounts — one connection each.

Authentication

Send an API key as a bearer token. The key must carry the ads.manage permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X POST https://api.zinndigital.com/v1/ads/connect/x/grants/{grant_id} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "customer_ids": <string[]> }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Gated on ads.manage; audit action ads.connection_create. Every action class starts approve. Up to 100 accounts a call; customer_ids are X ad account ids (lower-case base-36, a sandbox one as sbx-<id>). A change approved for a LIVE X account is refused with xWritesOff until live X writes are switched on (Vault secret/platform/x-ads production_writes); a sandbox account is written normally.

Parameters

Name	Type	Required	What it is
`grant_id (path)`	`string`	Yes	—
`org_id (query)`	`string`	No	—

Request body

Name	Type	Required	What it is
`customer_ids`	`string[]`	Yes	—
`org_id`	`string`	No	—

Response

Name	Type	Required	What it is
`data`	`AdsAccountConnection[]`	Yes	—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429