Create a broadcast

post

https://api.campaignrefinery.com/rest/broadcasts/create_broadcast

Creates a broadcast in a single call. Provide the message inline (message) or reference an existing template (template_uuid) -- exactly one of the two. Provide the audience as a segment (audience_uuid) or a group (audience_group_uuid) -- exactly one of the two. Optionally schedule it with schedule, or send as soon as possible with send_asap.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

broadcast_name

string

required

length between 2 and 255

Display name for the broadcast.

audience_uuid

uuid | null

Segment UUID. Mutually exclusive with audience_group_uuid; exactly one is required.

audience_group_uuid

uuid | null

Group UUID. Mutually exclusive with audience_uuid; exactly one is required.

template_uuid

uuid | null

Message template UUID. Mutually exclusive with message; exactly one is required.

message

object

Inline message. Mutually exclusive with template_uuid. When supplied, eds_uuid, footer_uuid, and subject are required, and either html_content or raw_html_content must be provided.

schedule

string | null

Date and time in YYYY-MM-DD HH:II:SS format (UTC).

send_asap

boolean

When true, the broadcast is queued to send immediately.

suppression_uuids

array of uuids

Suppression list UUIDs to attach to the broadcast. The array you send is the broadcast's complete suppression set: exactly these lists are attached, nothing else. Unknown UUIDs are ignored.

suppression_uuids

actions

array of objects

Tag-action rules. Each entry applies or removes tags when a contact opens the email, clicks any link, or clicks a specific link. The array you send is the broadcast's complete tag-action set: exactly these rules, nothing else. Unknown tag UUIDs are ignored.

actions

Responses

401

Missing or invalid bearer token.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Broadcast created.

404A referenced entity (audience, template, EDS, footer) was not found.

422Validation error. Common causes: missing broadcast_name; neither or both of audience_uuid/audience_group_uuid; neither or both of template_uuid/message; inline message missing eds_uuid/footer_uuid/subject or a body; from/reply-to email on a foreign domain.