Broadcasts

Create a broadcast

Creates it as a draft. Nothing is sent until the send endpoint is called.

post/broadcasts

Request

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

Request body

namestring required
audience_idstring uuid required
topic_idstring uuid nullable

Narrows the audience to the contacts subscribed to this topic. Omit (or send null) to reach the whole audience.

fromstring required

Must be on a verified sending domain.

reply_tostring
subjectstring required
htmlstring
editor_jsonobject nullable
template_idstring uuid
template_variablesobject
track_opensboolean
track_clicksboolean

Response

Created as a draft.

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

Changes

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