ads

POST /v1/ads/zaraz/connections

Connect one Cloudflare zone for Zaraz with a scoped token.

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 field in the JSON body.

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/zaraz/connections \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "token": <string>, "zone_id": <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

za-131 (docs/1006 §88). Gated on ads.manage; audit action ads.zaraz_connect. The token must reach the zone and be able to READ and EDIT Zaraz on it (proved by reading the zone's Zaraz workflow, then a config PUT whose body can never be a config — Cloudflare answers 400 to a token with Zaraz Edit and 403 without; nothing is written). The token goes to Vault (secret/orgs/<org>/ads/zaraz/<id>) before the row is saved and is never stored in the database or returned. Connecting a zone again replaces its token. Refusals: refusal.adsconnect.zaraz.<code> — tokenShape, tokenRejected, permissionMissing, zoneNotFound, rateLimited, unavailable, unexpected, vaultUnavailable.

Request body

NameTypeRequiredWhat it is
org_idstringNo—
tokenstringYes—
zone_idstringYes—

Response

NameTypeRequiredWhat it is
dataAdsZarazConnectionYesA Cloudflare zone connected for Zaraz (za-131). The token is in Vault, never here; token_hint is its last four characters.

Errors this endpoint can return

401 · 403 · 404 · 422 · 429