API ReferenceAudiences

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.
idstringRequiredformat: "^aud_"

Audience ID. This identifier is a string that always begins with the prefix aud_, for example: aud_abc123.

contactslist of stringsRequired

Array of phone numbers (E.164 format) or contact IDs.

Limit: 1 min

Response

Successfully removed contacts from the audience.
idstring

Audience public ID. This identifier is a string that always begins with the prefix aud_, for example: aud_abc123.

namestring
Audience name.
descriptionstring
Audience description.
contactCountinteger

Total number of contacts in audience.

Use the Get Audience endpoint with the pagination parameters to get the audience with its contacts.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error