Create message template

post

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

Creates a new message template for the authenticated account. References the sending domain and footer by UUID. Supply either html_content (visual-editor HTML) or raw_html_content (custom raw HTML with use_raw_html_content set to true). If from_email or reply_to_email are supplied, their domain must match the sending domain of the referenced EDS.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

message_name

string

required

length between 2 and 255

Display name for the template.

eds_uuid

uuid

required

Sending domain (EDS) UUID.

footer_uuid

uuid

required

Footer UUID.

subject

string

required

length between 2 and 255

Email subject line.

preview_text

string | null

Optional preview text shown in inbox clients.

html_content

string | null

Standard visual-editor HTML body. Required unless raw_html_content is supplied. Supports merge tags and offer link variables, e.g. {{offer_link_4821}}, which resolve for a broadcast built from this template only when that offer is linked to the broadcast; when it is not, the variable resolves to an empty string, leaving an empty href rather than visible text.

raw_html_content

string | null

Custom raw HTML body. Required when use_raw_html_content is true. Supports merge tags and offer link variables, e.g. {{offer_link_4821}}, which resolve for a broadcast built from this template only when that offer is linked to the broadcast; when it is not, the variable resolves to an empty string, leaving an empty href rather than visible text.

use_raw_html_content

boolean

When true, raw_html_content is the body that sends.

reply_tracking

boolean

from_name

string | null

from_email

string | null

Must match the sending domain of the referenced EDS.

reply_to_name

string | null

reply_to_email

string | null

Must match the sending domain of the referenced EDS.

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

201Template created.

404The referenced EDS or footer was not found for the authenticated account.

422Validation error. Common causes: missing message_name/eds_uuid/footer_uuid/subject, neither html_content nor raw_html_content supplied, or a from/reply-to email whose domain does not match the sending domain.