Documentation
Sign inGet started

bird email broadcasts

Usage

Codebeispiel
bird email broadcasts

Description

Recipients resolve at dispatch: audience members with an address, minus those suppressed for the broadcast's category. A broadcast leaves draft once submitted, and a scheduled one stays editable until dispatch begins. Cancelling never recalls what already went out, and a draft is deleted rather than cancelled.
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

NameDescription
cancelCancel a broadcast
countsGet a broadcast's audience counts
createCreate a broadcast
deleteDelete a broadcast
getGet a broadcast
listList broadcasts
list-eventsList events for a broadcast
list-recipientsList recipients of a broadcast
sendSend a broadcast
updateUpdate a draft or scheduled broadcast