Email templates

Update email template

Changed on

Update an email template: rename, change the subject or senders, replace its content, or publish/unpublish it (status). Content is re-rendered server-side. Sending html to a block template converts it to an HTML template, one way — an HTML template cannot take a document again. A PUBLISHED template is live: journeys that send it use the change from their next send, so any update to one requires confirm: true (call without it first to see the refusal). Omitted fields are unchanged.

patch/api/v1/email-templates/{templateId}

Request

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

Path parameters

templateIdstring required

Email template id.

Request body

namestring
subjectstring
htmlstring

Hand-written HTML (the template becomes an HTML template). Sanitized on save — scripts, event handlers and external stylesheets are removed and listed in removed. Variables use the same {{path}} grammar.

fromSenderIdstring nullable

Sender id to send From. Must be on the verified domain (usableAsFrom in journeys_email_templates). Null/omitted = the org default.

replyToSenderIdstring nullable

Sender id for Reply-To. Null/omitted = the org default.

status'DRAFT' | 'PUBLISHED'

PUBLISHED makes it usable by SEND_EMAIL nodes; DRAFT withdraws it, and journeys that send it will then fail to send.

confirmboolean

Must be true to change a template that is PUBLISHED.

Response

Success

removedstring[] required

What the HTML sanitizer removed. Empty for block content.

Changes