ads
POST /v1/ads/zaraz/connections/{connection_id}/install
One-click install - write the tracking hub's tools, triggers and consent into the zone.
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/zaraz/connections/{connection_id}/install \
-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
za-132 (docs/1006 §110). Gated on ads.manage; audit action ads.zaraz_install. Reads the zone's whole Zaraz configuration, replaces only the zinn_* tools and triggers and our two consent purposes from the org's tracking hub (za-126), keeps everything else of the customer's, and writes it back (published when the zone uses the preview workflow). No site code. Networks Zaraz cannot run from a public id are listed in skipped. Refusals (422, refusal.adsconnect.zarazSync.<code> or refusal.adsconnect.zaraz.<code>): hubEmpty, foreignSecrets (the zone holds secret variables that a write could erase), consentShape, tokenRejected, permissionMissing, zoneNotFound, rateLimited, unavailable (Cloudflare answered 5xx), unexpected (our side failed, §2.57), vaultUnavailable.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
connection_id (path) | string | Yes | — |
org_id (query) | string | No | — |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
consent | boolean | No | Ask visitors for consent with Zaraz's banner (a banner already on stays on). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | AdsZarazActionResult | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429