Email templates

Email templates are what a journey’s SEND_EMAIL node sends. You can author them in the app’s builder, or from an agent or script with four tools (each is also a REST endpoint):

Tool	Endpoint	Does
`email_templates_list`	`GET $BASE/email-templates`	Every template, draft and published, with its status, mode and variables
`email_templates_get`	`GET $BASE/email-templates/{templateId}`	One template in full — edit it and send it back
`email_templates_create`	`POST $BASE/email-templates`	Create a template as a draft
`email_templates_update`	`PATCH $BASE/email-templates/{templateId}`	Rename, change subject/senders/content, publish or unpublish

A template is written one of two ways, and you send exactly one:

document — the builder’s blocks: heading, text, button, image, divider, spacer, html, social, footer, plus container (a framed card) and columns (side by side). Styling is optional; what you leave out takes the builder’s defaults.
html — your own markup. It is sanitized on save: scripts, event handlers and external stylesheets are removed, and the response lists what was removed in removed.

Boom renders the deliverable HTML and plain text itself. Variables use the {{path}} grammar in the subject and the body — {{customer.name}}, {{person.<attribute>}}, {{engagement.chatLink}} — and resolve at send; see Template variables for what a path can be.

{
  "name": "Recordatorio de pago",
  "subject": "Hola {{customer.name}}, tu pago vence pronto",
  "document": {
    "body": { "language": "es", "preheader": "Evita recargos" },
    "blocks": [
      { "type": "heading", "text": "Tu pago vence el viernes" },
      { "type": "text", "text": "Hola {{customer.name}}, aún tienes un saldo pendiente." },
      { "type": "button", "text": "Pagar ahora", "href": "https://example.com/pay" },
      { "type": "footer", "text": "Empresa S.A. de C.V., Ciudad de México" }
    ]
  }
}

The same template as HTML is { "name": …, "subject": …, "html": "<table>…</table>" }.

Sending one

A template sends through a journey. Build it on an email initiative with a SEND_EMAIL step that points at the PUBLISHED template (journeys_email_templates lists those, along with whether your domain and sender are ready), then launch the initiative, which publishes the journey. Then enroll people:

Directly: initiatives_participants_add with an email for each person.
On behavior: give the journey a cdp_event trigger, and every time that event is recorded for a person with an email (cdp_events_record), they are enrolled.

People on your Do Not Contact list are skipped either way.

Rules worth knowing

New templates are drafts. A journey can only send a PUBLISHED template; publish with email_templates_update and "status": "PUBLISHED".
Changing a published template needs "confirm": true. Journeys reference the template itself, so an edit changes what they send from their next send, and setting it back to DRAFT makes those sends fail. Call without confirm first to see the refusal.
Unknown fields are rejected, not ignored, so a typo such as background for a button’s bg fails with a validation error instead of quietly taking the default.
Blocks → HTML is one way. Sending html to a block template converts it; an HTML template does not accept a document again.
A footer block goes at the top level of the email, not inside a container or a column. Omit unsubscribeLabel for the document language’s default link text, or send "" for no unsubscribe link (transactional email).
Not available here yet: test sends, image upload (use an image URL you host, or one from the builder’s library), and deleting a template.

Start here

How Boom works

Connect your tools

Reference

Email templates

Sending one

Rules worth knowing

​Sending one

​Rules worth knowing

Sending one

Rules worth knowing