Remove Contacts from Audience
Remove contacts from an existing audience. This operation is idempotent.
- Only removes contacts that exist in the audience
- Contacts not in the audience are ignored
Authentication
PINNACLE-API-KEYstring
API Key authentication via header
Request
Request payload for removing contacts from an audience.
id
Audience ID. This identifier is a string that always begins with the prefix aud_, for example: aud_abc123.
contacts
Array of phone numbers (E.164 format) or contact IDs (minimum 1 item).
Response
Successfully removed contacts from the audience.
id
Audience public ID. This identifier is a string that always begins with the prefix aud_, for example: aud_abc123.
name
Audience name.
description
Audience description.
contactCount
Total number of contacts in audience.
Use the Get Audience endpoint with the pagination parameters to get the audience with its contacts.
