ads

PUT /v1/ads/brief

State the objective and the budget once, for every network.

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.

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

NameTypeRequiredWhat it is
org_idstringNo—
objectivestring<leads, revenue>Yes—
budget_minorintegerYesThe monthly budget, integer minor units of currency (§2.8).
currencystringYesISO 4217
targetobjectNoleads — a cost per conversion in minor units; revenue — a ROAS in %.
test_share_pctintegerNoThe share the networks with no measured return test with (recommended 10).
modestring<suggest, auto>No—

Response

NameTypeRequiredWhat it is
org_idstringYes—
briefobjectYes—
test_share_recommendedintegerYes—
test_share_minintegerYes—
test_share_maxintegerYes—
keep_daysintegerYes—
measured_atobjectYes—
blockedstring<, noReturnYet>Yes—
splitobject[]Yes—
movesAdsCrossBudgetMove[]Yes—
last_applyobjectYes—
can_undo_briefbooleanYes—
versionsobject[]Yes—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429