ads
PUT /v1/ads/brief
State the objective and the budget once, for every 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.
Where your organisation id goes
This endpoint takes org_id as a field in the JSON body.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X PUT https://api.zinndigital.com/v1/ads/brief \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "objective": <string<leads, revenue>>, "budget_minor": <integer>, "currency": <string> }'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_set. Sets the cross-network monthly ceiling to budget_minor and ranks the split by objective; the brief it replaces is kept 30 days for undoAdsBrief. Measured again now by a Temporal workflow, never in the request; nothing is applied (approve-first unless mode: auto). Refusals refusal.adsconnect.briefBadObjective, briefBadBudget, briefBadCurrency, briefBadTarget, briefBadTestShare, briefBadMode.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
org_id | string | No | — |
objective | string<leads, revenue> | Yes | — |
budget_minor | integer | Yes | The monthly budget, integer minor units of currency (§2.8). |
currency | string | Yes | ISO 4217 |
target | object | No | leads — a cost per conversion in minor units; revenue — a ROAS in %. |
test_share_pct | integer | No | The share the networks with no measured return test with (recommended 10). |
mode | string<suggest, auto> | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
org_id | string | Yes | — |
brief | object | Yes | — |
test_share_recommended | integer | Yes | — |
test_share_min | integer | Yes | — |
test_share_max | integer | Yes | — |
keep_days | integer | Yes | — |
measured_at | object | Yes | — |
blocked | string<, noReturnYet> | Yes | — |
split | object[] | Yes | — |
moves | AdsCrossBudgetMove[] | Yes | — |
last_apply | object | Yes | — |
can_undo_brief | boolean | Yes | — |
versions | object[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429