ads

PUT /v1/ads/cross-budget

Set or clear the one monthly ceiling across every network, and the mode.

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/cross-budget \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "ceiling_minor": <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.cross_budget_set. ceiling_minor: null clears it. mode suggest (the person applies) or auto (applied daily, Undo still works). A new ceiling is measured now by a Temporal workflow, never in the request. Refusals refusal.adsconnect.crossBadCeiling, crossBadCurrency, crossBadMode.

Request body

NameTypeRequiredWhat it is
org_idstringNo—
ceiling_minorobjectYesInteger minor units of currency (§2.8).
currencystringNoISO 4217
modestring<suggest, auto>No—

Response

NameTypeRequiredWhat it is
org_idstringYes—
ceiling_minorobjectYes—
currencyobjectYes—
modestring<suggest, auto>Yes—
measured_atobjectYes—
networksAdsCrossBudgetNetwork[]Yes—
proposalobjectYes—
last_applyobjectYes—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429