Sign in

v1

latestOpenAPI 3.0.32026-07-26737274.2 KB
Broadcasts

Create a broadcast

Draft or schedule to send a broadcast to all or a subset of your subscribers.<br/><br/>To save a draft, set send_at to null.<br/><br/>To publish to the web, set public to true.<br/><br/>To schedule the broadcast for sending, provide a send_at timestamp. Scheduled broadcasts should contain a subject and your content, at a minimum.<br/><br/>We currently support targeting your subscribers based on segment or tag ids.<aside class='notice'>Starting point templates are not currently supported.</aside>

post/v4/broadcasts

Request body

email_template_idinteger

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

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 nullable

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

thumbnail_altstring nullable
thumbnail_urlstring nullable
preview_textstring required
subjectstring required

Response

Creates a new broadcast