One broadcast, with its delivery progress. Safe to poll while it drains.

get/v1/mailboxes/{mailboxId}/broadcasts/{broadcastId}

Request

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

Path parameters

mailboxIdstring required
broadcastIdstring required

Response

The request has succeeded.

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.