ads
POST /v1/ads/briefs/{brief_id}/plans
Make each named network's plan from the brief (now, or later to add a network).
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}/plans \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "networks": <string<google, microsoft, x> | object[]> }'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_plans (za-292/za-293). Every network's plan comes from the same build: Google and Microsoft campaigns natively, X as a campaign with a line item and a promoted Tweet per ad group. Each network gets split[network] percent of the brief's budget (default: the room left, shared equally); shares across the brief never pass 100. A network already launched is never rebuilt. Nothing is queued.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
brief_id (path) | string | Yes | — |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
networks | string<google, microsoft, x> | object[] | Yes | — |
split | object | No | — |
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