ads

PATCH /v1/ads/own-share

Turn sharing across this company's own accounts on or off, and choose 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 PATCH https://api.zinndigital.com/v1/ads/own-share \
  -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.own_share_set. share_learning: false stops this org's accounts giving or receiving. share_mode approve (default: every shared change waits for a person through the change gate) or auto (applied, metered, Undo kept). A rejected shared change is never offered again.

Request body

NameTypeRequiredWhat it is
org_idstringNo—
share_learningbooleanNo—
share_modestring<approve, auto>No—

Response

NameTypeRequiredWhat it is
share_learningbooleanYes—
share_modestring<approve, auto>Yes—
swept_onobjectYes—
company_idstringYes—
learnedobjectYes—
shared_changesobjectYes—

Errors this endpoint can return

400 · 401 · 403 · 404 · 422 · 429