bird email broadcasts update

Usage

Code example

bird email broadcasts update <broadcast-id> [flags]

Only the fields you pass change. A broadcast whose delivery has already started can no longer be edited. To clear a nullable field (template, reply-to, ip-pool-id), pass an explicit null in the request body: no flag sends a null, and --body-file takes a path or "-" for stdin, never inline JSON.

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

# the body it prints:

Code example

{
  "category": "marketing",
  "template": {
    "id": "emt_01krdgeqcxet5s7t44vh8rt9mg"
  }
}

Code example

# clear the IP pool (a null only reaches the wire on stdin)
echo '{"ip_pool_id": null}' | bird email broadcasts update <broadcast-id> --body-file -

Options

Content

Name	Description
--from	Sender address. Accepts a bare address or RFC 5322 "Name <addr>" form
--audience-id	Audience to send to
--template	Template ID (emt_…). The broadcast sends this template's published version
--reply-to <value>…	Reply-To address; repeatable. Accepts bare addresses or RFC 5322 "Name <addr>" form

Labels & metadata

Name	Description
--header <key=value>	Custom header as Key=Value; repeatable. Replaces the existing headers
--tag <key=value>	Tag as name=value; repeatable. Replaces the existing tags
--metadata	Arbitrary JSON metadata object. Replaces the existing metadata
--category	Content classification: marketing or transactional
--ip-pool-id	IP pool ID (ipp_…) to send from

Tracking

Name	Description
--track-opens	Track open events (default true)
--track-clicks	Track click events (default true)

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 email broadcasts cancel	Cancel a broadcast
bird email broadcasts counts	Get a broadcast's audience counts
bird email broadcasts create	Create a broadcast
bird email broadcasts delete	Delete a broadcast
bird email broadcasts get	Get a broadcast
bird email broadcasts list	List broadcasts
bird email broadcasts list-clicked-links	List a broadcast's clicked links
bird email broadcasts list-events	List events for a broadcast
bird email broadcasts list-recipients	List recipients of a broadcast
bird email broadcasts send	Send a broadcast
bird email broadcasts send-quota	Get how much of a broadcast the send allowance covers

Related resources

Continue with the documentation, guides and examples for this topic. Resources are in English.

Watch the guideGetting started with email Explore the capabilityEmail Follow the learning pathBuild your first integration Implementation guideSend your first email

Try the practice and get an implementation brief