ads

POST /v1/ads/connect/chatgpt/grants/{grant_id}

Connect the key's ChatGPT Ads account and start reading its figures.

All ads endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

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/chatgpt/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. customer_ids is the account id the picker listed (adacct_…, lower case). The new connection's day figures (spend, clicks, impressions and conversions per ad group and day, money as integer micros of the account currency) start reading on their own (Temporal), READ ONLY, then the history backfill.

Parameters

NameTypeRequiredWhat it is
grant_id (path)stringYes—
org_id (query)stringNo—

Request body

NameTypeRequiredWhat it is
customer_idsstring[]Yes—
client_org_idstringNo—
org_idstringNo—

Response

NameTypeRequiredWhat it is
dataAdsAccountConnection[]Yes—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429