Documentation
Sign inGet started

bird email cancel

Usage

Code example
bird email cancel <message-id> [flags]

Description

Cancel a scheduled email before it sends. Only works while the message's status is still scheduled. Once it starts sending, or was already canceled, the call returns a conflict error. Canceling does not return consumed scheduled-send quota.
This is destructive and cannot be undone; pass --yes to confirm.

Examples

Code example
bird email cancel <id> --yes

Options

Safety

NameDescription
--idempotency-keyDeduplication key; a retry with the same key won't act twice
--yesConfirm a destructive action (required; the CLI never prompts)
NameDescription
bird email contentGet stored message content
bird email getGet a message
bird email listList messages
bird email recipientsList recipients of a message
bird email sendSend an email message
bird email send-batchSend a batch of email messages in one call