Skip to Content

The MailTemplate type of the TypeScript SDK, which templates.create and templates.update take or answer.

type MailTemplate = {
  createdAt: number
  defaultLang: string
  from: string | null
  languages: string[]
  name: string
  replyTo: string | null
  slug: string
  updatedAt: number
  variables: Record<string, MailTemplateVariablesValue>
  version: number
}

Fields

FieldTypeDescription
createdAtnumber
defaultLangstring
fromstring | nullThe From address; always set on a template this API created
languagesstring[]The languages this template has copy for
namestring
replyTostring | null
slugstring
updatedAtnumber
variablesRecord<string, MailTemplateVariablesValue>
versionnumberBumped by every write that changes what a send would produce

Used by

MethodWhat it does
templates.createCreate a mail template
templates.updateUpdate a template's metadata

Used in

MailTemplateDetail, MailTemplateList.