ads

PATCH /v1/ads/connections/{connection_id}

Rename, pause (the account's kill switch), set modes or spend ceilings.

All ads endpoints

All developer docs →

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.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

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

curl -X PATCH https://api.zinndigital.com/v1/ads/connections/{connection_id} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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_update. status: paused stops every write to the account. modes sets off, approve (the default) or auto per action class. Ceilings are integer minor units of the account's own currency; a raise that would take the enabled daily budgets past daily_ceiling_minor, or a month of them (x 30.4) past monthly_ceiling_minor, is refused.

Parameters

NameTypeRequiredWhat it is
connection_id (path)stringYes—

Request body

NameTypeRequiredWhat it is
labelstringNo—
statusstring<active, paused>No—
modesobjectNo—
daily_ceiling_minorobjectNo—
monthly_ceiling_minorobjectNo—
ceiling_currencystringNo—

Response

NameTypeRequiredWhat it is
idstringYes—
org_idstringYes—
platformAdsPlatformYesAn advertising platform (docs/1006; Reddit removed by the owner 2026-10-18).
external_idstringYes—
login_external_idstringYesThe manager account it is reached through.
labelstringYes—
statusstring<active, paused, disconnected>Yes—
modesAdsModesYesThe mode per action class.
daily_ceiling_minorobjectYes—
monthly_ceiling_minorobjectYes—
ceiling_currencystringYes—
account_currencystringYesThe ad account's own ISO 4217 currency.
pending_changesintegerYes—
created_atstringYes—
disconnected_atobjectYes—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429