ads

POST /v1/ads/briefs/{brief_id}/launch

Queue the named networks' plans as approve-first changes, together.

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.

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}/launch \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "networks": <string<google, microsoft, x>[]> }'

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_launch (za-292). All or nothing. NOTHING is sent to any network: every change waits in the approval queue (listAdsChanges) with its Undo, and the kill switches, spend ceilings and good standing still decide when it is approved. Refused over the plan's spend bracket, over the offering's own ceiling (offeringCeiling), or when an account is paused or in another currency. Refused planStale when the build's budget or currency was edited after its plan was built (rebuild it first). Each campaign is assigned to the brief's offering (source launch).

Parameters

NameTypeRequiredWhat it is
brief_id (path)stringYes—

Request body

NameTypeRequiredWhat it is
networksstring<google, microsoft, x>[]Yes—

Response

NameTypeRequiredWhat it is
idstringYes—
org_idstringYes—
offering_idstringYes—
offeringAdsOfferingNo—
build_idstringYes—
build_statusstringNo—
domainstringNo—
namestringNo—
monthly_budget_minorintegerYes—
currencystringYes—
objectivestringNo—
splitobjectYes—
created_atstringNo—
plansAdsBriefPlan[]No—
can_addstring[]No—
unlaunchAdsBriefUnlaunchNoza-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…
networksobject[]No—

Errors this endpoint can return

401 · 404 · 422 · 429