USuseboom
Email templates

Preview email template

Changed on

Render an email template with real data and read back the subject, HTML and text a recipient would get. Pick a stored event (eventId, eventExternalId, or latestEventName [+ personExternalId]) and its properties fill event.* and engagement.workflowState., exactly as in a journey triggered by that event, including inside Liquid tags ({% if event.amount > 0 %}, {% for i in event.items %}). When the event names a person, customer. and person.* come from that person, with fields the organization marked sensitive hidden. Without an event, sample values are used. unresolved lists the paths of variables that rendered blank, liquidError is set when the Liquid failed, and redactedKeys lists event fields hidden because the organization marked them sensitive (always hidden to an assistant). Read-only: nothing is sent; use it to check a template before publishing or before a journey sends it.

post/api/v1/email-templates/{templateId}/preview

Request

  • Base URL
    https://www.useboom.ai
  • Auth
    HTTP bearer

Path parameters

templateIdstring required

Email template id.

Request body

eventIdstring

Boom's id for the event (cdp_events_list / cdp_events_get).

eventExternalIdstring

The id your own backend sent the event with.

latestEventNamestring

Use the most recent event with this name, e.g. "payment_due". Narrow it to one person with personExternalId.

personExternalIdstring

With latestEventName: that person's most recent event.

valuesobject

path -> text to use instead of the event or sample value, e.g. { "customer.name": "Brian" }.

bindingsobject

A journey Send email step's rebindings (variable key -> path), to preview the email as that step sends it.

Response

Success

subjectstring required
htmlstring required
textstring nullable required
unresolvedstring[] required

Variables that rendered blank and had no fallback.

liquidErrorstring nullable required

Set when the Liquid failed and the output is a fallback.

redactedKeysstring[] required

Event fields masked as sensitive.

Changes