Broadcasts

Update or schedule a broadcast

Editable while draft or scheduled. Setting scheduled_at schedules it; setting it to null unschedules it back to draft. An update that leaves the broadcast scheduled runs the same checks as POST /broadcasts/{id}/send.

patch/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.

Request body

namestring
audience_idstring uuid
topic_idstring uuid nullable

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

fromstring
reply_tostring nullable
subjectstring
htmlstring
editor_jsonobject nullable
template_idstring uuid nullable
template_variablesobject nullable
scheduled_atstring date-time nullable
track_opensboolean
track_clicksboolean

Response

Updated.

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.