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. The response returns the linked offers, each with the variable that carries that offer's link in the message body, and the no_offer flag. An offer's variable is the same in every broadcast, so one already known from an earlier response can go straight into the html. When it is not yet known, placing an offer link in the body takes a second call: create here with offer_uuids, then send the variable in the html via update_broadcast_message, which replaces the whole message.

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

Optional complete set of tag-action rules on create. Each entry applies or removes account-owned tags on open, click, or reply. Supply tag UUIDs from get_tags; numeric tag IDs are not accepted. A click rule may match any link or one exact link URL, campaign placeholder, or offer placeholder.

actions

offer_uuids

array of uuids

Offers this broadcast promotes, from get_offers. Linking drives offer reporting and revenue attribution, and returns the variable that places each offer's link in the message body.

offer_uuids

offer_links

array of objects

Per-offer link parameter rows. Each entry names an offer in offer_uuids. rows is the complete list for that offer: every system row (email, sub1, sub2, sub6) exactly once, values editable and free to hold merge tags, plus any custom rows; send rows: null to reset that offer to the defaults. Values go out verbatim, never url-encoded. The response returns the effective rows, the attribution_slot the contact hash takes at send, and a preview of the outgoing link. When any entry is rejected, nothing is written.

offer_links

no_offer

boolean

Set true when the broadcast deliberately promotes no offer (accounts with an offer integration).

Responses

401

Missing or invalid bearer token.

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.