ads
POST /v1/ads/briefs/{brief_id}/unlaunch
Unlaunch a brief - pause everything it launched, approve-first, deleting nothing.
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 POST 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.manage; audit action ads.brief_unlaunch (za-317, owner ruling 2026-11-04). Every launch change still pending is rejected (nothing was sent for it); every campaign a launch change created gets a PAUSE change in the approval queue (listAdsChanges) on its own network (Google, Microsoft, X), which a person approves. An Unlaunch pause cannot be undone from Zinn® Ads. Once every item is paused or gone the brief is done: its plans become paused, the offering stops counting it against its ceiling, and its currency can change. Calling again moves it on and re-proposes a pause a person rejected or the network refused. An unlaunched brief is never launched again (unlaunched); make a new brief. Refused notLaunched when nothing was launched and unlaunchDone once done.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
brief_id (path) | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
org_id | string | Yes | — |
offering_id | string | Yes | — |
offering | AdsOffering | No | — |
build_id | string | Yes | — |
build_status | string | No | — |
domain | string | No | — |
name | string | No | — |
monthly_budget_minor | integer | Yes | — |
currency | string | Yes | — |
objective | string | No | — |
split | object | Yes | — |
created_at | string | No | — |
plans | AdsBriefPlan[] | No | — |
can_add | string[] | No | — |
unlaunch | AdsBriefUnlaunch | No | za-317: a brief's Unlaunch. status is empty (launched, or never launched), pausing (pauses wait for approval, or a launch change is still being applied) or done (everything… |
networks | object[] | No | — |
Errors this endpoint can return
401 · 404 · 422 · 429