bird audiences add-contacts

Usage

Exemple de code

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

Add up to 1,000 existing contacts by id. Adding a contact that is already a member has no effect; if any id does not exist the whole request fails and no contacts are added. Pass --contact-ids (repeatable) or a --body-file with a "contact_ids" array.

Build the request from flags, a JSON AudienceContactsAddRequest 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

Exemple de code

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

# the body it prints:

Exemple de code

{
  "contact_ids": ["con_01krdgeqcxet5s7t44vh8rt9mg"]
}

Exemple de code

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

Options

Contacts

Name	Description
--contact-ids <v1,v2,…>	Contact id to add; 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 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 remove-contacts	Remove contacts from a static audience.
bird audiences update	Update an audience's name or description.