Templates

A template turns a name and some data into a subject, an HTML body and a text body. Your app sends template and data; Flaresend renders the email.

await flaresend.emails.send({
  from: 'Acme <hello@acme.com>',
  to: 'ada@example.com',
  template: 'welcome',
  data: { name: 'Ada', appName: 'Acme', loginUrl: 'https://acme.com/login' },
});

No subject is needed: the template provides one.

Two kinds of templateCopy Anchor Link

Which template is usedCopy Anchor Link

When a send names a template, Flaresend looks in this order:

1. A custom template with that name in the sending project.
2. A built-in template with that name.
3. Neither: 404 template_not_found.

So a project can replace a built-in template by creating a custom one with the same name. Other projects keep using the built-in one. Delete the custom template and the project falls back to the built-in one again.

Overriding parts of a templateCopy Anchor Link

subject, html and text in the request take priority over what the template renders. The most common use is a custom subject:

await flaresend.emails.send({
  to: 'ada@example.com',
  template: 'welcome',
  data: { name: 'Ada', appName: 'Acme', loginUrl },
  subject: 'Ada, your Acme account is ready',
});

Everything else about the send (tags, attachments, scheduling, tracking, idempotency) works the same with a template.

Checking dataCopy Anchor Link

Data is checked when you send, before anything is stored:

• Built-in templates validate data against the template's schema. A missing or wrong field fails with 400 invalid_template_data, and param names the field, for example data.loginUrl.
• Custom templates check the variables marked required. A missing, null or empty one fails with 400 invalid_template_data.

Preview before sendingCopy Anchor Link

Render a template returns the subject, HTML and text for some data without sending anything. The dashboard's template editor uses it for its live preview.

const { subject, html, text } = await flaresend.templates.render('welcome', {
  name: 'Ada',
  appName: 'Acme',
  loginUrl: 'https://acme.com/login',
});

On the email recordCopy Anchor Link

Emails sent from a template have template (the name) and templateVersion (the custom template's version, or null for built-in templates) on their record, so you can tell which version someone received.