bird audiences update

Usage

Codebeispiel

bird audiences update <audience-id> [flags]

Description

Update an audience's name or description.

Only the fields you pass change; pass --name, --description, or both.

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

# the body it prints:

Codebeispiel

{
  "name": "Newsletter subscribers"
}

Codebeispiel

# rename an audience
bird email audiences update aud_123 --name "VIP customers"

Options

Audience

Name	Description
--name	New display name
--description	New description

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 remove-contacts	Remove contacts from a static audience.