ads

PATCH /v1/ads/offerings/{offering_id}

Change an offering, or archive or restore it.

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 PATCH https://api.zinndigital.com/v1/ads/offerings/{offering_id} \
  -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.offering_update. Only the fields sent change. A monthly ceiling cannot be set in a currency other than the one its launched campaigns committed (currencyCommitted).

Parameters

NameTypeRequiredWhat it is
offering_id (path)stringYes—

Request body

NameTypeRequiredWhat it is
org_idstringNoOn create, which of the caller's organisations owns it (required when there are several).
archivedbooleanNoOn update, archive (true) or restore (false) the offering.
namestringNo—
kindAdsOfferingKindNo—
tagsstring[]No—
urlsstring[]No—
marketsobject[]No—
monthly_budget_minorintegerNo—
currencystringNo—
objectivestring<, leads, revenue, traffic, installs>No—
archivedbooleanNo—

Response

NameTypeRequiredWhat it is
idstringYes—
org_idstringYes—
kindAdsOfferingKindYes—
namestringYes—
tagsstring[]Yes—
urlsstring[]Yes—
domainsstring[]Yes—
marketsobject[]Yes—
monthly_budget_minorintegerNo—
currencystringNo—
objectivestringNo—
archivedbooleanYes—
campaignsintegerYes—
created_atstringNo—

Errors this endpoint can return

401 · 404 · 422 · 429