Skip to main content
POST

Body Parameters

string
required
Sender email address.To include a friendly name, pass the sender as Name <email@example.com>, for example Acme <onboarding@example.dev>.
string
required
Email subject.
string
The HTML version of the message. You can include Contact Properties in the body of the Broadcast. Learn more about Contact Properties.
string
The plain text version of the message. You can include Contact Properties in the body of the Broadcast. Learn more about Contact Properties.
If not provided, the HTML will be used to generate a plain text version. You can opt out of this behavior by setting value to an empty string.
React.ReactNode
The React component used to write the message. Only available in the Node.js SDK.
string
The friendly name of the broadcast. Only used for internal reference.
boolean
Send the broadcast immediately after creation. Defaults to false.
When set to true, the broadcast will be sent or scheduled (if scheduled_at is provided) without requiring a separate call to the Send Broadcast endpoint.