Sequence Step

A descriptor of a single step within an automated sequence.

bounceCount
integer

The total count of bounced mailings during this sequence step.

clickCount
integer

The total count of clicked mailings from this sequence step.

createdAt
string <date-time>

The date and time the sequence step was created.

date
string <date>

The date this step will activate; only applicable to date-based sequences.

deliverCount
integer

The total count of delivered mailings from this sequence step.

displayName
string

A human-readable display name that captures the step’s type and order.

failureCount
integer

The total count of failed mailings from this sequence step.

interval
integer

The interval (in seconds) until this step will activate; only applicable to interval-based sequences.

negativeReplyCount
integer

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

neutralReplyCount
integer

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

openCount
integer

The total count of opened mailings from this sequence step.

optOutCount
integer

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

order
integer

The step’s display order within its sequence.

positiveReplyCount
integer

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

replyCount
integer

The total count of replied mailings from this sequence step.

scheduleCount
integer

The total count of scheduled mailings from this sequence step.

stepType
string <= 255 characters

The step’s type; must be "auto_email", "manual_email", "call" or "task".

taskAutoskipDelay
integer

The optional interval (in seconds) from when tasks created by this sequence step are overdue until they are automatically skipped.

taskNote
string <= 65535 characters

An optional note to associate with created tasks.

updatedAt
string <date-time>

The date and time the sequence step was last updated.

{
  • "bounceCount": 0,
  • "clickCount": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "date": "2019-08-24",
  • "deliverCount": 0,
  • "displayName": "string",
  • "failureCount": 0,
  • "interval": 0,
  • "negativeReplyCount": 0,
  • "neutralReplyCount": 0,
  • "openCount": 0,
  • "optOutCount": 0,
  • "order": 0,
  • "positiveReplyCount": 0,
  • "replyCount": 0,
  • "scheduleCount": 0,
  • "stepType": "string",
  • "taskAutoskipDelay": 0,
  • "taskNote": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Sequence Step Relationships

data (object) or links (object) (callPurpose)

The default call purpose associated with the sequence step. You can use only the attribute id to filter sequenceSteps by callPurpose (e.g. filter[callPurpose][id]=X).

Array of links (object) (call)

The calls associated with the sequence step. You can use only the attribute id to filter sequenceSteps by calls (e.g. filter[calls][id]=X).

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

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

Array of links (object) (mailing)

The mailings associated with the sequence step. Relationship mailings cannot be used as a filter.

data (object) or links (object) (sequence)

The associated sequence. You can use attributes id, enabledAt and name to filter sequenceSteps by sequence (e.g. filter[sequence][id]=X).

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

The sequence templates in use by this sequence step. You can use any filterable attribute of sequenceTemplates.

data (object) or links (object) (taskPriority)

The associated task priority. You can use only the attribute id to filter sequenceSteps by taskPriority (e.g. filter[taskPriority][id]=X).

Array of links (object) (task)

The tasks associated with the sequence step. You can use only the attribute id to filter sequenceSteps by tasks (e.g. filter[tasks][id]=X).

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

The most recent updater of the sequence step. You can use only the attribute id to filter sequenceSteps by updater (e.g. filter[updater][id]=X).

{
  • "callPurpose": {
    },
  • "calls": [
    ],
  • "creator": {
    },
  • "mailings": [
    ],
  • "sequence": {
    },
  • "sequenceTemplates": [
    ],
  • "taskPriority": {
    },
  • "tasks": [
    ],
  • "updater": {
    }
}

Sequence Step 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 Step Actions

Get a Collection of Sequence Steps

SecuritybearerAuth
Responses
200

OK

422

JSON error message

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


422
JSON error message


post/sequenceSteps
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Get a Sequence Step by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/sequenceSteps/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Update a Sequence Step
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


422
JSON error message


patch/sequenceSteps/{id}
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}