`bird audiences add-contacts`

Usage

Code example

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. To add contacts that do not exist yet, run "bird contacts batch" with audience ids instead: it matches or creates each contact by email address and assigns it in one call.

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

Code example

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

# the body it prints:

Code example

{
  "contact_ids": ["con_01krdgeqcxet5s7t44vh8rt9mg"]
}

Code example

# add two contacts
bird audiences add-contacts adn_01krdgeqcxet5s7t44vh8rt9mg --contact-ids con_01krdgeqcxet5s7t44vh8rt9mg --contact-ids con_01krdgeqcxet5s7t44vh8rt9mh

Options

Contacts

Name	Description
`--contact-ids <value>…`	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`	Unassign 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

Continue with the documentation, guides and examples for this topic.

Get an implementation brief

Related resources