Sign in
Email templates

Update an email template

post/email_templates/{id}

Path parameters

idstring required

The ID of the email template

Request body

namestring

The name of the email template

subjectstring

The subject of the email template. Variables are supported via {{ variableName }}

bodystring

The plaintext version of the body of the email template. Variables are supported via {{ variableName }}

template_htmlstring

The HTML representation of the email template. Mutually exclusive with plain text email templates.

template_jsonobject

The JSON representation of the email template. This will override the name, subject, and body properties

new_template_jsonobject

The JSON representing the rich text email template. Mutually exclusive with plain text email templates

new_template_htmlstring

The HTML representation of the rich text email template. Mutually exclusive with plain text email templates

kind'unlayer' | 'editor' | 'old_editor' | 'html'

The kind of the email template

metadataobject

The metadata for the email template

Response

The updated EmailTemplate object

idstring required

The ID of the email template

namestring required

The name of the email template

subjectstring required

The subject of the email template. Variables are supported via {{ variableName }}

bodystring nullable required

(Deprecated) The body of the email template. Always null since there are no plaintext emails

kind'html' | 'unlayer' | 'old_editor' | 'editor' required

The kind of the email template

template_htmlstring nullable required

The HTML representation of the rich text email. May be null

{"stackTrail":"components:schemas:EmailTemplate:properties:template_json","oasType":"schema","type":"unknown","description":"The JSON representing the rich text email template. May be null","nullable":true}
{"stackTrail":"components:schemas:EmailTemplate:properties:new_template_json","oasType":"schema","type":"unknown","description":"The new unlayer JSON template. May be null","nullable":true}
new_template_htmlstring nullable required

The new unlayer HTML template. May be null

metadataobject required

Arbitrary metadata associated with this email template

created_atstring required

The time when the email template was created in ISO 8601 format

enabled_atstring nullable

The time when the email template was enabled in ISO 8601 format

Changes