Types

EmailTemplate

An email template, a system template or a custom one. Stored templates are tenant-wide; legacy templates carried over from the platform belong to the token's organisation and are listed, reset and deleted for it only.

idrequired
string
The template slug, such as user_welcome. A leading underscore is accepted and ignored.
namerequired
string
The name the platform shows. A system template has a fixed name; a custom template has the name it was created with.
categoryrequired
string
The group the platform lists the template under. Custom templates are in Custom.
statusrequired
string
default is a system template with nothing stored, customised is a system template with a stored row (content, subject or only its switches), and custom is a template created through the API or the platform.One of: default, customised, custom
enabledrequired
boolean
Whether the platform sends this template. A disabled template is skipped.
cc_list_enabledrequired
boolean
Whether the recipient's CC list members are copied on this template.
assigned_internal_cc_enabledrequired
boolean
Whether the recipient's assigned internal user is copied on this template.
subjectrequired
string | null
The subject line. A system template falls back to its default subject when none is stored.
layout_moderequired
string
fragment content is placed in the theme's layout; standalone content is sent as it is.One of: fragment, standalone
content
string
The content the template sends: the stored content, else a legacy Horizon override, else the system default.
default_content
string | null
The system default content. Null for a custom template, which has no default.
default_subject
string | null
The system default subject. Null for a custom template, which has no default.
placeholders
object[]
The placeholders the template content can use: the common ones plus those found in its content.
created_atrequired
string | null (date-time)
When the template was first stored. Null while a system template has never been stored.
updated_atrequired
string | null (date-time)
When the template last changed. Null while a system template has never been stored.

Used by (5)