Send HTML Transactional

post

https://{APP_DOMAIN}/api/3.2/messages/transactionals

Sends a transactional email in one of three mutually-exclusive dispatch modes: (1) HTML mode — provide html, subject, sender_id, and reply_id (optionally template_id, binding_id, preview_line); (2) specific auto-responder mode — provide auto_responder_id alone; (3) default-auto-responder mode — provide publication_id and auto_responder_category_id together. Mixing fields across modes (e.g. sending publication_id alongside html) returns 422. Template wrapping and macro replacement apply in HTML mode when template_id is provided.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

string

required

Email to send the transactional message to.

html

string

required

HTML content to be sent

sender_id

integer

required

Sender ID used to send the message.

reply_id

integer

required

Sender ID used in the reply to.

subject

string

required

The email subject line

publication_id

integer

Publication ID. Switches this endpoint to auto-responder dispatch mode — must be sent together with auto_responder_category_id, and when present the endpoint sends the default auto responder for that publication/category instead of the HTML body. Do not include for HTML-mode requests.

auto_responder_category_id

integer

Auto responder category ID. Must be sent together with publication_id to send the default auto responder for that publication/category. Do not include for HTML-mode requests.

auto_responder_id

integer

ID of a specific auto responder to send. When present, the endpoint sends that auto responder and html/sender_id/reply_id/subject are not used. Do not include for HTML-mode requests.

template_id

integer

The ID of the template to wrap the HTML content with

binding_id

integer

The binding ID to use for sending. Defaults to the sender's publication binding if not provided.

variables

object

An object of variables (keyed by merge tag) to be replaced when the email is sent.

preview_line

string

The preview line of the auto responder.

Responses

422

The transactional could not be sent (e.g. invalid recipient or missing resolvable template).

201The created Html Transactional