bird email broadcasts cancel
Usage
Code example
bird email broadcasts cancel <broadcast-id> [flags]Description
Cancel a scheduled, accepted, or sending broadcast. This stops every delivery that has not gone out yet. Recipients already dispatched are not recalled. Calling this again on a broadcast already canceling or canceled returns its current state rather than an error. A draft cannot be canceled, because it was never sent. Delete it with bird email broadcasts delete instead.
This is destructive and cannot be undone; pass --yes to confirm.
Examples
Code example
bird email broadcasts cancel <id> --yesOptions
Safety
| Name | Description |
|---|---|
| --idempotency-key | Deduplication key; a retry with the same key won't act twice |
| --yes | Confirm a destructive action (required; the CLI never prompts) |
Options
| Name | Description |
|---|---|
| --response-schema | Print the fields this command returns, then exit |
Related
| Name | Description |
|---|---|
| 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 update | Update a draft or scheduled broadcast |