ads

POST /v1/ads/connections/{connection_id}/audiences

Create a Customer Match list, recording the consent its people gave.

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.

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 POST https://api.zinndigital.com/v1/ads/connections/{connection_id}/audiences \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string>, "consent_ad_user_data": <string<GRANTED, DENIED>>, "consent_ad_personalization": <string<GRANTED, DENIED>>, "consent_basis": <string>, "accept_terms": <boolean> }'

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.audience_created (consent values only). Nothing is sent to the network until both consents are GRANTED, the basis is recorded and Google's Customer Match terms are accepted (accept_terms). Google accounts only; at most 50 live lists per account (422 refusal.adsconnect.audienceLimit); names are unique among an account's live lists (422 refusal.adsconnect.audienceNameTaken) (FIX-REFUSED). A deleted list frees its slot and its name (OWNERFIX-B).

Parameters

NameTypeRequiredWhat it is
connection_id (path)stringYes—

Request body

NameTypeRequiredWhat it is
namestringYes—
descriptionstringNo—
consent_ad_user_datastring<GRANTED, DENIED>Yes—
consent_ad_personalizationstring<GRANTED, DENIED>Yes—
consent_basisstringYesHow the consent was collected
accept_termsbooleanYesThe customer accepts Google's Customer Match terms for this account.

Response

NameTypeRequiredWhat it is
idstringYes—
namestringYes—
descriptionstringNo—
activebooleanYesFalse once emptied.
consentobjectYes—
membersobjectYes—
blocked_byobjectYesWhy nothing is sent now. noSourceConsent (za-95) = the list is filled from a CRM source whose Customer Match consents (BOTH ad_user_data and ad_personalization) are not…
last_statusstring<never, synced, processing, refused, failed>Yes—
last_reasonstringNo—
last_run_atobjectNo—
last_ok_atobjectNo—
added_lastintegerNo—
removed_lastintegerNo—
at_network_listbooleanNo—
crm_feedAdsAudienceCrmFeed | nullNoza-95 — the CRM source filling this list automatically (null = an uploaded list).
created_atstringYes—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429