Template

A reusable template for building emails.

archived
boolean

Boolean value indicating if the template has been archived.

archivedAt
string <date-time>

The date and time the template was archived.

bccRecipients
Array of strings

A list of default person and email address pairs to receive this template in the "bcc" field (e.g. [Billy Bob <billy.bob@seattle.city>])

bodyHtml
string <= 16777215 characters

The body HTML of the template.

bodyText
string <= 16777215 characters

The body text of the template.

bounceCount
integer

The total count of bounced mailings during this template.

ccRecipients
Array of strings

A list of default person and email address pairs to receive this template in the "cc" field (e.g. [Billy Bob <billy.bob@seattle.city>])

clickCount
integer

The total count of clicked mailings from this template.

createdAt
string <date-time>

The date and time the template was created.

deliverCount
integer

The total count of delivered mailings from this template.

failureCount
integer

The total count of failed mailings from this template.

lastUsedAt
string <date-time>

The last time the template was used.

name
string <= 225 characters

The name of the template.

negativeReplyCount
integer

The total count of negative reply mailings from this template.

neutralReplyCount
integer

The total count of neutral reply mailings from this template.

openCount
integer

The total count of opened mailings from this template.

optOutCount
integer

The total count of opted out mailings from this template.

positiveReplyCount
integer

The total count of positive reply mailings from this template.

replyCount
integer

The total count of replied mailings from this template.

scheduleCount
integer

The total count of scheduled mailings from this template.

shareType
string <= 255 characters

The share type must be one of "read_only," "private," or "shared".

subject
string

The subject line for the email to be sent.

tags
Array of strings

A list of tag values associated with the template (e.g. ["Sequencing", "Quick Response"]).

toRecipients
Array of strings

A list of default person and email address pairs to receive this template in the "to" field (e.g. ["Billy Bob billy.bob@seattle.city"])

trackLinks
boolean

Boolean value indicating if link tracking is on for the template.

trackOpens
boolean

Boolean value indicating if open tracking is on for the template.

updatedAt
string <date-time>

The date and time the template was last updated.

{
}

Template Relationships

Array of data (object) or links (object) (contentCategoryMembership)

The content cateogories with which this template is associated. Relationship contentCategoryMemberships cannot be used as a filter.

data (object) or links (object) (user)

The creator of the template. You can use only the attribute id to filter templates by creator (e.g. filter[creator][id]=X).

data (object) or links (object) (user)

The owner of the template. You can use only the attribute id to filter templates by owner (e.g. filter[owner][id]=X).

Array of data (object) or links (object) (recipient)

A list of default email addresses to receive this template. You can use only the attribute id to filter templates by recipients (e.g. filter[recipients][id]=X).

Array of data (object) or links (object) (sequenceTemplate)

The sequence templates using the template for their content. Relationship sequenceTemplates cannot be used as a filter.

data (object) or links (object) (user)

The creator of the template. You can use only the attribute id to filter templates by updater (e.g. filter[updater][id]=X).

{
}

Template Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canWrite A boolean value indicating whether the current API user has write access to this resource. provideAuthorizationMeta
canDelete A boolean value indicating whether the current API user has delete access to this resource. provideAuthorizationMeta

⌵ Template Actions

Get a Collection of Templates

SecuritybearerAuth and s2sAuthToken
Responses
200

OK

422

JSON error message

get/templates
Request samples 
Response samples 
application/vnd.api+json
{
}
Create a New Template
SecuritybearerAuth 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/templates
Request samples 
application/vnd.api+json
{
}
Response samples 
application/vnd.api+json
{
}
Delete an Existing Template by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
204
Deleted


422
JSON error message


delete/templates/{id}
Request samples 
Response samples 
application/vnd.api+json
{
}
Get a Template by ID
SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/templates/{id}
Request samples 
Response samples 
application/vnd.api+json
{
}
Update a Template
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


422
JSON error message


patch/templates/{id}
Request samples 
application/vnd.api+json
{
}
Response samples 
application/vnd.api+json
{
}