Broadcasts

Update a broadcast

Updates a draft or scheduled broadcast. Only fields included in the request body change. Clearing scheduled_at demotes a scheduled broadcast back to a draft; setting it on a draft schedules it. A broadcast that is already sending or sent can no longer be edited.

patch/broadcasts/{id}

Request

  • Base URL: https://api.crevio.co/v1
  • URL: https://api.crevio.co/v1/broadcasts/{id}
  • Auth: API key in header Authorization

Path parameters

idstring required

The broadcast's prefixed id (e.g. bcst_abc123).

Request body

fromstring nullable

Sender email address (uses account default if omitted)

tostring[]

List of recipient email addresses

subjectstring

Email subject line

bodystring

Email body content

customer_typestring nullable

Filter recipients by customer type

send_to_allboolean nullable

Send to all customers

Response

The updated broadcast

objectstring required
idstring required
subjectstring nullable required
preview_textstring nullable required
bodystring nullable required
html_bodystring nullable required
fromstring nullable required
reply_tostring nullable required
styledboolean required
audienceobject required
audience_descriptionstring required
status'draft' | 'scheduled' | 'sending' | 'sent' | 'canceled' | 'failed' required
scheduled_atstring date-time nullable required
started_atstring date-time nullable required
sent_atstring date-time nullable required
canceled_atstring date-time nullable required
statsobject required
errorstring nullable required
metadataobject required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.