bird email broadcasts resume
Usage
bird email broadcasts resume <broadcast-id> [flags]Description
Resume a broadcast
Continue a paused broadcast after adding funds if needed. It continues delivery to remaining eligible recipients, applying current consent and suppression checks for its saved category, and does not count as another broadcast against the monthly broadcast allowance. A broadcast that started sending 24 hours or more ago requires confirmation with --yes or "confirm": true in --body-file, because its remaining recipients get the message late. For an older broadcast without a recorded sending start, the 24-hour period begins at send authorization, or creation if authorization is also missing. Read started_at and the pinned template references with bird email broadcasts get <broadcast-id> --format json, then check the template with bird email templates get <template-ref> --format json using template.id. A scope of system identifies a built-in template. If the template read returns 404, try its pinned version by ID because published workspace versions remain readable after deletion. For a workspace template, read the original content with bird email templates versions get <template-ref> <version-id> --format json using template.id as template_ref and template.version_id as version_id. Built-in lookups show current catalogue content. Broadcasts with frozen content keep it, but older broadcasts can read the catalogue again when resumed. Neither a current lookup nor an earlier message alone proves what remaining recipients will receive. Leave the broadcast paused unless you can verify that content. Review template.language, or the version's default_language when no language was selected. Reading template content needs email_management:read; if you lack it, ask an authorized teammate to review the content before you confirm. Without either form of confirmation, a late resume reports how long ago the broadcast started and changes nothing. Confirmation skips no other check. Returns 403 for suspension now or since send authorization. E04102 means reactivation cannot restore this broadcast's authorization; cancel it instead of retrying. Do not resend to the full audience without excluding recipients already sent to. Returns 402 while funds are still short, or 409 for any status other than paused. A 422 means concurrency is full or the sender or IP pool needs repair; read the error details to decide whether to wait or repair. A 503 means balance or limits could not be checked; retry later. These refusals leave a paused broadcast unchanged. An exhausted daily or monthly sending allowance returns 429 and keeps the broadcast paused. Retry this broadcast after the allowance resets or its limit changes. Returns a sending snapshot when resumption is accepted; delivery continues asynchronously. Use bird email broadcasts get <broadcast-id> --format json to follow progress and any later funding hold or terminal status.
Build the request from flags, a JSON EmailBroadcastResume 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
# print the body shape (no credentials needed)
bird email broadcasts resume --example
# the body it prints:{
"confirm": true
}Options
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 |
|---|---|
--yes | Acknowledgment that the message reaches the remaining recipients later than intended. It is required to resume a broadcast that started sending at least 24 hours ago. Before setting it, read the broadcast's started_at and have a reviewer with email_management:read check its pinned template version using template.id and template.version_id. Workspace versions retain the original content. Built-in template lookups (scope: system) show current catalogue content. Broadcasts with frozen content keep it, but older broadcasts can read the catalogue again when resumed. Neither a current lookup nor an earlier message alone proves what remaining recipients will receive. Leave the broadcast paused unless you can verify that content. Ask an authorized teammate if you lack that permission. It does not skip the funds or concurrent-broadcast checks. |
--response-schema | Print the fields this command returns, then exit |
Related
| 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 preview | preview a broadcast |
bird email broadcasts send | Send a broadcast |
bird email broadcasts send-quota | Get the email send allowance for a broadcast |
bird email broadcasts test | test a broadcast |
bird email broadcasts update | Update a draft or scheduled broadcast |
bird email broadcasts validate | validate a broadcast |
Related resources
Continue with the documentation, guides and examples for this topic.