v1

latestOpenAPI 3.0.32026-07-26737274.2 KB

Broadcasts

Update a broadcast

Update an existing broadcast. Continue to draft or schedule to send a broadcast to all or a subset of your subscribers. To save a draft, set public to false. To schedule the broadcast for sending, set public to true and provide send_at. Scheduled broadcasts should contain a subject and your content, at a minimum. We currently support targeting your subscribers based on segment or tag ids.

put/v4/broadcasts/{id}

Path parameters

idinteger required

Request body

email_template_idinteger required

Id of the email template to use. Uses the account's default template if not provided. 'Starting point' template is not supported.

email_addressstring nullable required

The sending email address to use. Uses the account's sending email address if not provided.

contentstring required

The HTML content of the email.

descriptionstring required

publicboolean required

true to publish this broadcast to the web. The broadcast will appear in a newsletter feed on your Creator Profile and Landing Pages.

published_atstring required

The published timestamp to display in ISO8601 format. If no timezone is provided, UTC is assumed.

send_atstring required

The scheduled send time for this broadcast in ISO8601 format. If no timezone is provided, UTC is assumed.

{"stackTrail":"paths:/v4/broadcasts/{id}:put:requestBody:content:application/json:schema:properties:thumbnail_alt","oasType":"schema","type":"unknown","nullable":true}

{"stackTrail":"paths:/v4/broadcasts/{id}:put:requestBody:content:application/json:schema:properties:thumbnail_url","oasType":"schema","type":"unknown","nullable":true}

preview_textstring required

subjectstring required

Response

Updates the broadcast and returns its details