ads
POST /v1/ads/briefs
Save one brief for many networks and start reading the site.
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 POST https://api.zinndigital.com/v1/ads/briefs \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'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_create (za-291). The brief belongs to an offering (offering_id, else a website offering is made from url) and owns ONE Simple-mode build: the site is read once (getAdsBuild follows it; review and build the plan there), then each network's plan is made from it with planAdsLaunchBrief.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
org_id | string | No | — |
offering_id | string | No | — |
build_id | string | No | Adopt an existing Simple-mode build as the brief (its budget, currency and markets); one brief per build, returned as it is when it exists. A build already launched through its… |
url | string | No | — |
name | string | No | — |
monthly_budget_minor | integer | No | — |
currency | string | No | — |
markets | object[] | No | — |
offer | string | No | — |
offers_free | boolean | No | — |
objective | string<, leads, revenue, traffic, installs> | 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 · 403 · 404 · 422 · 429