Email Templates

Email templates are reusable full email body templates. They render with Handlebars variables and can be used by workflows, campaigns, or both.

Delivery sender identity comes from the selected mailbox for tenant email. Platform/auth email may use the platform sender.

Create Email Template

const template = await sdk.emailTemplate.createEmailTemplate({
key: 'newsletter-feature-update',
  subject: { en: '{{subject}}' },
  preheader: '{{preheader}}',
  body: '<h1>{{title}}</h1><div>{{body}}</div>',
  variables: [
    { key: 'subject' },
    { key: 'preheader' },
    { key: 'title' },
    { key: 'body' }
  ],
sample_data: {
  subject: 'June update',
  preheader: 'A few updates from the team.',
  title: 'June update',
  body: '<p>Here is what changed this month.</p>'
},
from_name: 'My Store',
from_email: 'sender-default@example.com'
});

Template Variables

Templates use Handlebars syntax:

• {{subject}} escapes text values

• {{body}} renders escaped body text

• nested variables can be referenced with paths such as {{store.name}}

  Declare variables so the UI, previews, workflows, and campaigns know which values can be filled before sending.

	variables: [
	  { key: 'subject' },
	  { key: 'body' },
	  { key: 'cta_url' }
		]

Preview Email Template

const preview = await sdk.emailTemplate.previewEmailTemplate({
  id: 'tmpl_abc123',
  vars: {
    subject: 'June update',
    title: 'June update',
    body: '<p>Here is what changed this month.</p>'
  }
});

console.log(preview.subject, preview.html, preview.warnings);

List Email Templates

const { items, cursor } = await sdk.emailTemplate.getEmailTemplates({
  query: 'newsletter',
  status: 'active',
  limit: 20,
});

Update Email Template

await sdk.emailTemplate.updateEmailTemplate({
  id: 'tmpl_abc123',
  subject: { en: '{{subject}}' },
  body: '<h1>{{title}}</h1><div>{{body}}</div>',
  status: 'active',
});

Default Templates

Every new store includes shared email templates: