A send names a from address on a verified sending domain and is accepted for delivery
rather than delivered on the call, so a message's outcome is read back afterwards.
Reads return JSON; list is paginated. Mutations take flags and/or a --body-file JSON body (flags overriding); run --example to print the body shape or --dry-run to preview the request.
Send an email
Deliver email to explicit recipients. The sender must be a verified domain, or the shared onboarding domain on a new workspace; the result is accepted (queued, delivered asynchronously), not yet delivered.
Requires: The from must be a sender the workspace can use: a verified sending domain, or the shared onboarding domain on a new workspace.
- bird email send — Returns accepted (HTTP 202), delivered asynchronously; not confirmation of delivery. Next: bird email get
| Name | Description |
|---|
| send | Send an email message |
| send-batch | Send a batch of email messages in one call |
| get | Get a message |
| list | List messages |
| cancel | Cancel a scheduled message |
| content | Get stored message content |
| recipients | List recipients of a message |
| Name | Description |
|---|
| templates | Author and manage reusable email templates |
| Name | Description |
|---|
| domains | Manage email sending domains |
| dedicated-ips | Buy, warm, and pool dedicated sending IPs |
| ip-pools | Group dedicated IPs into pools a send can target |
| suppressions | Manage the email suppression list |
| tools | Email deliverability tools |
| Name | Description |
|---|
| mailboxes | Manage agent email mailboxes |
| threads | Read and reply to mailbox conversation threads |
| Name | Description |
|---|
| broadcasts | Send one piece of content to a stored audience |
| Name | Description |
|---|
| stats | Read aggregate email statistics |