Sign in

v1

latestOpenAPI 3.1.02026-08-0612447737.4 KB
Send Broadcast

Send Broadcast Message

Send a Broadcast message to a list of recipients and / or segments

post/send_broadcast

Request body

attachmentstring nullable

Attachment URL. Can either https:// or media_library://

fromstring uuid required

The channel the broadcast is sent from

template_idstring uuid required

The template to use for the broadcast

require_marketing_opt_inboolean

Whether the recipients must have opted in to marketing messages

to_segmentsstring[] nullable

The list of segments to send the broadcast to

send_afterstring date-time nullable

The time to send the broadcast after

placeholder_valuesstring[] nullable

Placeholder values

marketing_channel_idstring uuid nullable

Marketing Channel ID

review_channel_idstring uuid nullable

Review Channel ID

Response

The broadcast was sent successfully