ads

POST /v1/public/ads-wordpress/zaraz/install

One-click install of the tracking hub into the site's zone, from wp-admin.

All ads endpoints

All developer docs →

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

Authentication

This endpoint does not take an API key. It takes its own credential, issued to the plugin or service that calls it, as a bearer token; see the description above.

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 POST https://api.zinndigital.com/v1/public/ads-wordpress/zaraz/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-312. Site token only; audit action ads.zaraz_install. The dashboard's installAdsZaraz on the connection for this site's zone: only the zinn_* tools, triggers and our two consent purposes are written, Zaraz is switched on (autoInjectScript) and everything else of the customer's is kept; the zone is versioned first so the dashboard's 30-day undo reaches it. 404 (refusal.adsconnect.zaraz.noSuchConnection) until the zone is connected. Refusals as installAdsZaraz.

Request body

NameTypeRequiredWhat it is
consentobjectNoAsk visitors for consent with Zaraz's banner (a banner already on stays on). Omitted or null keeps the zone's current consent switch.

Response

NameTypeRequiredWhat it is
dataAdsZarazActionResultYes—

Errors this endpoint can return

401 · 404 · 422 · 429