Audiences > contacts

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
delete/audiences/contacts

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/audiences/contacts
  • Auth: API key in header PINNACLE-API-KEY

Request body

idstring required

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

contactsstring[] required

Array of phone numbers (E.164 format) or contact IDs. <br><br> Limit: 1 min

Response

Successfully removed contacts from the audience.

idstring required

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

namestring required

Audience name.

descriptionstring required

Audience description.

contactCountinteger required

Total number of contacts in audience.

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

Changes

No recorded changes to this operation across all 1 revision of this API.