Documentation
Sign inGet started

Remove contacts from an audience

POST
/v1/audiences/{audience_id}/contacts/remove
await bird.audiences.removeContacts("adn_01krdgeqcxet5s7t44vh8rt9mg", {
  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.
Paramètres
audience_id
string
ID of the audience to remove contacts from (adn_-prefixed).
Corps de la requête
contact_ids
array of string
obligatoire
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.