email-audiences

Unassign contacts from an audience

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 422 Unprocessable Entity and no memberships are removed. The contacts themselves are not deleted and remain members of any other audiences.

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

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/audiences/{audience_id}/contacts/remove
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Path parameters

audience_idstring required
Example:adn_01krdgeqcxet5s7t44vh8rt9mg

ID of the audience to remove contacts from.

Headers

Idempotency-Keystring

Client-supplied key. On operations supporting request deduplication, a retained response is replayed for duplicate requests with the same key within the idempotency window (3 hours by default). This protection requires a workspace, organization, or staff-account scope. User-only and unscoped unauthenticated operations, streams, and operations with a separate replay contract do not use this response replay.

On a supported operation, if idempotency protection is unavailable before execution, the API returns 503 IdempotencyUnavailable (E01033) without executing this attempt. Retry with backoff using the same key and request. An operation that takes effect before its response is retained can still execute again on retry.

Two distinct 409 errors signal misuse:

  • request_in_progress (E01004): The same key is currently being processed by a concurrent request. Wait briefly and retry. The lock expires within 30 seconds.
  • idempotency_key_reuse (E01005): The same key has already completed against a different request body or method. Generate a new key.

Recommended key format is <event-type>/<entity-id> (for example welcome-user/usr_abc123).

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Request body

contact_idsContactID[] 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.

Example request

{
  "contact_ids": [
    "con_01krdgeqcxet5s7t44vh8rt9mg"
  ]
}

Response

Contacts removed from the audience.

Changes

No recorded changes to this operation across all 2 revisions of this API.