ads
POST /v1/ads/connections/{connection_id}/audiences/{audience_id}/members
Add, remove or replace the people on a Customer Match list (hashed on arrival).
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/{audience_id}/members \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "mode": <string<add, remove, replace>>, "members": <object[]> }'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_members_uploaded (counts only). Each person is an e-mail and/or a phone in E.164 (+ and country code), or email_sha256 / phone_sha256 you hashed yourself (SHA-256 hex of the normalised value); a name is used only with country and postcode. Plain values are normalised and hashed the moment they are parsed and never stored, logged or returned. replace makes the list exactly this upload. The same upload twice changes nothing. Starts the sync workflow. A deleted list is a 422 refusal.adsconnect.audienceDeleted (FIX-REFUSED).
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
connection_id (path) | string | Yes | — |
audience_id (path) | string | Yes | — |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
mode | string<add, remove, replace> | Yes | — |
members | object[] | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
received | integer | Yes | — |
accepted | integer | Yes | — |
unusable | integer | Yes | — |
added | integer | Yes | — |
removed | integer | Yes | — |
unchanged | integer | Yes | — |
sync_started | boolean | Yes | — |
audience | AdsAudience | Yes | A customer's own Customer Match list (docs/1006 §72). Counts only, never an identifier. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429