ads

GET /v1/ads/briefs/{brief_id}/unlaunch

What Unlaunch would pause or cancel now (nothing is written).

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.view 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 GET https://api.zinndigital.com/v1/ads/briefs/{brief_id}/unlaunch \
  -H "Authorization: Bearer zdk_live_…"

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.view (za-317). Each launched change and campaign with the state Unlaunch would move it to (will_cancel, will_pause, in_flight, …). Once an Unlaunch has started, its recorded progress.

Parameters

NameTypeRequiredWhat it is
brief_id (path)stringYes—

Response

NameTypeRequiredWhat it is
statusstring<, pausing, done>Yes—
requested_atstringYes—
unlaunched_atstringYes—
itemsobject[]YesOne entry per launched change and per campaign it created.

Errors this endpoint can return

401 · 404 · 429