bird audiences create

Usage

Ejemplo de código

bird audiences create <name> [flags]

New audiences start empty. Add contacts with "bird email audiences add-contacts" or the bulk "bird email contacts batch". --type defaults to static; dynamic and external are preview values and are currently rejected.

Build the request from the <name> argument and flags, a JSON AudienceCreateRequest body via --body-file ("-" reads stdin), or both — an inline value 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

Ejemplo de código

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

# the body it prints:

Ejemplo de código

{
  "description": "Contacts who opted into the monthly product newsletter",
  "name": "Newsletter subscribers"
}

Ejemplo de código

# create a static audience
bird email audiences create "VIP customers"

# preview the request without creating
bird email audiences create "VIP customers" --dry-run

Options

Audience

Name	Description
--description	Longer description of who this audience is
--type	Audience type: static (dynamic and external are preview and unavailable) (default static)

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 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.