textstring
The new plain text body.
Broadcasts
Update a broadcast
Change a draft broadcast's audience, sender, subject or body.
PATCH
/v1/broadcasts/{id}API keyOnly draft broadcasts can be edited. Once a broadcast is scheduled or sending, cancel it and create a new one.
Every field is optional; the ones you leave out keep their value.
Path parameters
The broadcast ID.
Body parameters
audienceIdstring
Send to a different audience.
fromstring
A new sender. Checked against the project's allowed domains and senders.
subjectstring
1 to 998 characters.
htmlstring
The new HTML body.
The same per-contact variables work in subject, html and text.
Response
The updated broadcast with counts, as in Retrieve a broadcast.
Errors
| Status | Code | When |
|---|---|---|
| 400 | invalid_body | A field is malformed, or from is not a valid address. |
| 403 | invalid_sender | from is not on the project's allowed domains or senders. |
| 404 | broadcast_not_found | No broadcast with that ID in this project. |
| 404 | audience_not_found | audienceId is not an audience in this project. |
| 409 | broadcast_not_draft | The broadcast is not a draft. |