bird email broadcasts
Usage
Code example
bird email broadcastsDescription
Recipients resolve when the send starts: audience members with an address, minus those
suppressed for the broadcast's category. A scheduled broadcast stays editable until sending
starts. Canceling never recalls what already went out, and a draft is deleted, not canceled.
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. Destructive commands require --yes.
Commands
| Name | Description |
|---|---|
| cancel | Cancel a broadcast |
| counts | Get a broadcast's audience counts |
| create | Create a broadcast |
| delete | Delete a broadcast |
| get | Get a broadcast |
| list | List broadcasts |
| list-clicked-links | List a broadcast's clicked links |
| list-events | List events for a broadcast |
| list-recipients | List recipients of a broadcast |
| send | Send a broadcast |
| send-quota | Get how much of a broadcast the send allowance covers |
| update | Update a draft or scheduled broadcast |
Related resources
Continue with the documentation, guides and examples for this topic. Resources are in English.
Watch the guideGetting started with emailExplore the capabilityEmailFollow the learning pathBuild your first integrationImplementation guideSend your first email
Try the practice and get an implementation brief