Broadcasts

Get a broadcast

The broadcast with per-status recipient counts in stats.

get/broadcasts/{id}

Request

  • Base URL: https://api.eusend.dev
  • URL: https://api.eusend.dev/broadcasts/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The broadcast id.

Response

The broadcast.

idstring uuid required
organizationIdstring uuid
namestring required
status'draft' | 'scheduled' | 'sending' | 'sent' | 'paused' | 'held' | 'cancelled' required

held is a send stopped for review; unlike paused it is not resumable by the customer.

audienceIdstring uuid nullable
fromAddressstring required
replyTostring nullable
subjectstring required
htmlstring nullable
reactSourcestring nullable
editorJsonobject nullable
templateIdstring uuid nullable
templateVariablesobject nullable
heldReasonstring nullable
scheduledAtstring date-time nullable
startedAtstring date-time nullable
completedAtstring date-time nullable
recipientCountinteger nullable
sentCountinteger nullable
trackOpensboolean
trackClicksboolean
createdAtstring date-time required
updatedAtstring date-time nullable
statsobject required

Recipient counts keyed by email status, e.g. { "delivered": 1204, "bounced": 3 }.

Changes

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