Draft a broadcast. Sends nothing until it is dispatched.

post/v1/mailboxes/{mailboxId}/broadcasts

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL /authorize, token URL /oauth/token, scopes: email.write)
    • HTTP bearer

Path parameters

mailboxIdstring required

Request body

audienceIdstring required
templateIdstring required
fromstring required

Required — a broadcast has no default sender, any more than a send does. It must route into THIS mailbox — the one the broadcast belongs to and accounts for every recipient of — resolved as inbound mail is: the exact address, then without its +tag, then the domain's catch-all. Checked here, and again at dispatch, since routes can change between the two.

Response

The request has succeeded and a new resource has been created as a result.

idstring required
audienceIdstring required
templateIdstring required
fromstring required

The address every recipient is sent from, as the rail will send it.

status'draft' | 'sending' | 'sent' required
recipientCountinteger required

Audience members discovered so far, including those it will not send to (see BroadcastProgress.skipped). 0 until dispatch enumerates the audience on the queue.

createdAtstring date-time required
sentAtstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.