Campaigns

Edit a draft broadcast

Change any field accepted when creating a broadcast. Only unscheduled drafts can be edited: a scheduled draft returns 409 until it is unscheduled.

patch/broadcasts/{id}

Request

Path parameters

idstring required

Request body

namestring
list_idstring
fromstring

Sender on a verified workspace domain.

reply_tostring
subjectstring
preview_textstring
htmlstring
textstring
markdownstring

Markdown body, converted to a block document rendered with the workspace design. Not combinable with html or content.

editor'html' | 'blocks'
contentobject nullable

Block document ({ type: 'doc', content: [...] }) as the dashboard editor stores it. Without html, it is rendered with the workspace design.

track_opensboolean
track_clicksboolean

Response

Successful response

idstring required
namestring required
statusstring required
listIdstring required
fromstring required
replyTounknown required
subjectstring required
previewTextstring required
htmlstring required
textunknown required
templateunknown required
editorstring required
contentunknown required
testSentAtunknown required
scheduledAtunknown required
startedAtunknown required
completedAtunknown required
nextAttemptAtunknown required
lastErrorunknown required
createdAtstring date-time required
updatedAtstring date-time required

Changes

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