bird email broadcasts send

Usage

Codebeispiel

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

Send a draft broadcast, immediately or at scheduled_at. Running this again on a broadcast that is already scheduled changes the time it will send. It does not send a second copy. A broadcast whose delivery has already started returns a conflict error.

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

# the body it prints:

Codebeispiel

{
  "scheduled_at": "2026-12-01T09:00:00Z"
}

Options

Delivery

Name	Description
--scheduled-at	Schedule the send for a future time (RFC 3339, e.g. 2026-07-10T09:00:00Z); omit to send immediately

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-quota	Get how much of a broadcast the send allowance covers
bird email broadcasts update	Update a draft or scheduled broadcast

Verwandte Ressourcen