ads

GET /v1/ads/briefs/{brief_id}

One brief with each network's plan and the networks it could add now.

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.view 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 GET https://api.zinndigital.com/v1/ads/briefs/{brief_id} \
  -H "Authorization: Bearer zdk_live_…"

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.view. can_add lists the live, connected networks not on the brief yet (za-293).

Parameters

NameTypeRequiredWhat it is
brief_id (path)stringYes—

Response

NameTypeRequiredWhat it is
idstringYes—
org_idstringYes—
offering_idstringYes—
offeringAdsOfferingNo—
build_idstringYes—
build_statusstringNo—
domainstringNo—
namestringNo—
monthly_budget_minorintegerYes—
currencystringYes—
objectivestringNo—
splitobjectYes—
created_atstringNo—
plansAdsBriefPlan[]No—
can_addstring[]No—
unlaunchAdsBriefUnlaunchNoza-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…
networksobject[]No—

Errors this endpoint can return

401 · 404 · 429