Sequence Template

An object used to track which templates are in use by which sequence steps.

bounceCount
integer or null

The total count of bounced mailings during this sequence template.

clickCount
integer or null

The total count of clicked mailings from this sequence template.

createdAt
string or null <date-time>

The date and time the sequence template was created.

deliverCount
integer or null

The total count of delivered mailings from this sequence template.

enabled
boolean or null

Boolean indicating if the sequence template is currently enabled.

enabledAt
string or null <date-time>

Datetime for when the sequence template was enabled.

failureCount
integer or null

The total count of failed mailings from this sequence template.

isReply
boolean or null

Boolean indicating if the sequence template should be a reply email or a new thread.

negativeReplyCount
integer or null

The total count of negative reply mailings from this sequence template.

neutralReplyCount
integer or null

The total count of neutral reply mailings from this sequence template.

openCount
integer or null

The total count of opened mailings from this sequence template.

optOutCount
integer or null

The total count of opted out mailings from this sequence template.

positiveReplyCount
integer or null

The total count of positive reply mailings from this sequence template.

replyCount
integer or null

The total count of replied mailings from this sequence template.

scheduleCount
integer or null

The total count of scheduled mailings from this sequence template.

updatedAt
string or null <date-time>

The date and time the sequence template was last updated.

{
  • "bounceCount": 0,
  • "clickCount": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "deliverCount": 0,
  • "enabled": true,
  • "enabledAt": "2019-08-24T14:15:22Z",
  • "failureCount": 0,
  • "isReply": true,
  • "negativeReplyCount": 0,
  • "neutralReplyCount": 0,
  • "openCount": 0,
  • "optOutCount": 0,
  • "positiveReplyCount": 0,
  • "replyCount": 0,
  • "scheduleCount": 0,
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Sequence Template Relationships

object

User that created the sequence template. You can use only the attribute id to filter sequenceTemplates by creator (e.g. filter[creator][id]=X).

object

The sequence step that uses the sequence template. You can use any filterable attribute of sequenceStep.

object

The template used for this sequence template. You can use only the attribute id to filter sequenceTemplates by template (e.g. filter[template][id]=X).

object

User that last updated the sequence template. You can use only the attribute id to filter sequenceTemplates by updater (e.g. filter[updater][id]=X).

{
  • "creator": {},
  • "sequenceStep": {},
  • "template": {},
  • "updater": {}
}

Sequence 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

⌵ Sequence Template Actions

Get a Collection of Sequence Templates

SecuritybearerAuth
Responses
200

OK

422

JSON error message

get/sequenceTemplates
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    ]
}
Create a New Sequence Template
SecuritybearerAuth 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


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


422
JSON error message


delete/sequenceTemplates/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "errors": [
    ]
}
Get a Sequence Template by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/sequenceTemplates/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Update a Sequence 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/sequenceTemplates/{id}
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Activate
Member Action


Enable the sequence step associated with it.


SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


422
JSON error message


post/sequenceTemplates/{id}/actions/activate
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Deactivate
Member Action


Disable the sequence step associated with it.


SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


422
JSON error message


post/sequenceTemplates/{id}/actions/deactivate
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}