Remove contacts from an audience

POST

/v1/audiences/{audience_id}/contacts/remove

curl -X POST "https://us1.platform.bird.com/v1/audiences/{audience_id}/contacts/remove" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "contact_ids": [
      "con_01krdgeqcxet5s7t44vh8rt9mg"
    ]
  }'

Removes up to 1,000 contacts from an audience. Contacts that are not members are skipped. If any contact ID does not exist in the workspace, the whole request fails with a validation error and no memberships are removed. The contacts themselves are not deleted and remain members of any other audiences.

Parameters

audience_id

string

ID of the audience to remove contacts from (adn_-prefixed).

Request Payload

contact_ids

array of string

required

Contacts to remove from the audience. Removing a contact that is not a member has no effect; duplicate IDs in the list are collapsed. If any ID does not exist in the workspace, the whole request fails with a validation error and no memberships are removed.

curl -X POST "https://us1.platform.bird.com/v1/audiences/{audience_id}/contacts/remove" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "contact_ids": [
      "con_01krdgeqcxet5s7t44vh8rt9mg"
    ]
  }'