Skip to main content
PUT
Update an email template, layout or system email.

Authorizations

Authorization
string
header
required

Enter your access token (OAuth / JWT).

Path Parameters

templateUid
string | null
required

The Uid of the template, as returned by the list endpoint.

Body

application/json

The fields to change.

The fields of an email template that an update may change. Every field is optional: a field left out keeps its current value.

Body
string

The HTML of the template. May use Liquid tokens, for example {{ Person.FirstName }}, and must keep every token in the template's RequiredTokens. Cannot be null.

Description
string | null

What the template is for. Cannot be changed for a system email.

Design
string | null

The design of the template in the drag-and-drop editor, as JSON. Send null with a new Body so the editor opens the new Body as HTML instead of the old design.

Name
string

The name of the template, shown in the Outseta app. Cannot be changed for a system email. Cannot be null.

Subject
string | null

The subject line of the email. May use Liquid tokens, for example {{ CompanyName }}.

Response

Created
string<date-time>
required
read-only
Minimum string length: 1
Updated
string<date-time>
required
read-only
Minimum string length: 1
Name
string
required
Required string length: 1 - 250
Body
string
required
Minimum string length: 1
Uid
string | null
Maximum string length: 10
_objectType
string | null
ActivityEventData
unknown
Subject
string | null
Maximum string length: 1000
Design
string | null
Description
string | null
Maximum string length: 1000
SystemName
string | null
Maximum string length: 50
IsInternal
boolean
AvailableTokens
string | null
RequiredTokens
string | null
Tag
string | null