bird audiences remove-contacts

Usage

Codebeispiel

bird audiences remove-contacts <audience-id> [flags]

Remove up to 1,000 contacts by id. Removing a contact that is not a member has no effect; if any id does not exist the whole request fails and no contacts are removed. The contacts themselves are not deleted. Pass --contact-ids (repeatable) or a --body-file with a "contact_ids" array.

Build the request from flags, a JSON AudienceContactsRemoveRequest body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Examples

Codebeispiel

# print the body shape (no credentials needed)
bird audiences remove-contacts --example

# the body it prints:

Codebeispiel

{
  "contact_ids": ["con_01krdgeqcxet5s7t44vh8rt9mg"]
}

Codebeispiel

# remove two contacts
bird email audiences remove-contacts aud_123 --contact-ids con_1 --contact-ids con_2

Options

Contacts

Name	Description
--contact-ids <v1,v2,…>	Contact id to remove; repeatable

Request

Name	Description
--body-file	Read the JSON request body from this file; "-" reads stdin
--example	Print a complete example request body, then exit
--dry-run	Print the resolved request without sending it, then exit
--idempotency-key	Deduplication key; a retry with the same key won't act twice

Options

Name	Description
--response-schema	Print the fields this command returns, then exit

Name	Description
bird audiences add-contacts	Add contacts to a static audience.
bird audiences create	Create an audience.
bird audiences delete	Delete an audience
bird audiences get	Get an audience
bird audiences list	List audiences
bird audiences list-contacts	List an audience's contacts
bird audiences remove-contact	Remove a contact from an audience
bird audiences update	Update an audience's name or description.