Documentation
Sign inGet started

bird audiences add-contacts

Usage

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

Description

Add contacts to a static audience
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

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

# the body it prints:
Codebeispiel
{
  "contact_ids": ["con_01krdgeqcxet5s7t44vh8rt9mg"]
}
Codebeispiel
# add two contacts
bird audiences add-contacts adn_01krdgeqcxet5s7t44vh8rt9mg --contact-ids con_01krdgeqcxet5s7t44vh8rt9mg --contact-ids con_01krdgeqcxet5s7t44vh8rt9mh

Options

Contacts

NameDescription
--contact-ids <v1,v2,…>Contact id to add; repeatable

Request

NameDescription
--body-fileRead the JSON request body from this file; "-" reads stdin
--examplePrint a complete example request body, then exit
--dry-runPrint the resolved request without sending it, then exit
--idempotency-keyDeduplication key; a retry with the same key won't act twice

Options

NameDescription
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird audiences createCreate an audience
bird audiences deleteDelete an audience
bird audiences getGet an audience
bird audiences listList audiences
bird audiences list-contactsList an audience's contacts
bird audiences remove-contactRemove a contact from an audience
bird audiences remove-contactsRemove contacts from a static audience
bird audiences updateUpdate an audience's name or description