Sequence State

A descriptor of a currently sequenced prospect, which includes relationships to its sequence, prospect and user.

activeAt
string <date-time>

The date and time the sequence state was last active.

bounceCount
integer

The total count of bounced mailings during this sequence state.

callCompletedAt
string <date-time>

The date and time the sequence state last had a call completed.

clickCount
integer

The total count of clicked mailings from this sequence state.

createdAt
string <date-time>

The date and time the sequence state was created.

deliverCount
integer

The total count of delivered mailings from this sequence state.

errorReason
string <= 255 characters

The reason for the most recent error.

failureCount
integer

The total count of failed mailings from this sequence state.

negativeReplyCount
integer

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

neutralReplyCount
integer

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

openCount
integer

The total count of opened mailings from this sequence state.

optOutCount
integer

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

pauseReason
string <= 255 characters

The reason for the most recent pause.

positiveReplyCount
integer

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

repliedAt
string <date-time>

The date and time the sequence state last had a mailing reply.

replyCount
integer

The total count of replied mailings from this sequence state.

scheduleCount
integer

The total count of scheduled mailings from this sequence state.

state
string <= 255 characters

The current state of the sequence state.

stateChangedAt
string <date-time>

The date and time the sequence state’s state last changed.

updatedAt
string <date-time>

The date and time the sequence state was last updated.

{
  • "activeAt": "2019-08-24T14:15:22Z",
  • "bounceCount": 0,
  • "callCompletedAt": "2019-08-24T14:15:22Z",
  • "clickCount": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "deliverCount": 0,
  • "errorReason": "string",
  • "failureCount": 0,
  • "negativeReplyCount": 0,
  • "neutralReplyCount": 0,
  • "openCount": 0,
  • "optOutCount": 0,
  • "pauseReason": "string",
  • "positiveReplyCount": 0,
  • "repliedAt": "2019-08-24T14:15:22Z",
  • "replyCount": 0,
  • "scheduleCount": 0,
  • "state": "string",
  • "stateChangedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Sequence State Relationships

data (object) or links (object) (account)

The account associated with the prospect the sequence state is targeting. You can use only the attribute id to filter sequenceStates by account (e.g. filter[account][id]=X).

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

Any undelivered mailings associated with the current sequence step. Relationship activeStepMailings cannot be used as a filter.

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

Any incomplete tasks associated with the current sequence step. Relationship activeStepTasks cannot be used as a filter.

data (object) or links (object) (batchItem)

The batch item associated with this creation, if one exists.

Array of links (object) (call)

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

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

The creator of the sequence state. Relationship creator cannot be used as a filter.

data (object) or links (object) (mailbox)

The mailbox to use for mailing steps. You can use attributes id and email to filter sequenceStates by mailbox (e.g. filter[mailbox][id]=X).

Array of links (object) (mailing)

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

data (object) or links (object) (opportunity)

The associated opportunity. You can use only the attribute id to filter sequenceStates by opportunity (e.g. filter[opportunity][id]=X).

data (object) or links (object) (prospect)

The primary prospect this sequence state is targeting. You can use attributes id and emails to filter sequenceStates by prospect (e.g. filter[prospect][id]=X).

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

The sequence this prospect is engaged in. You can use any filterable attribute of sequence.

data (object) or links (object) (sequenceStep)

The current sequence step the prospect is in. You can use any filterable attribute of sequenceStep.

Array of links (object) (task)

The tasks associated with the sequence state. You can use attributes id and dueAt to filter sequenceStates by tasks (e.g. filter[tasks][id]=X).

{
  • "account": {
    },
  • "activeStepMailings": [
    ],
  • "activeStepTasks": [
    ],
  • "batchItemCreator": {
    },
  • "calls": [
    ],
  • "creator": {
    },
  • "mailbox": {
    },
  • "mailings": [
    ],
  • "opportunity": {
    },
  • "prospect": {
    },
  • "sequence": {
    },
  • "sequenceStep": {
    },
  • "tasks": [
    ]
}

Sequence State Resource Metadata

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

⌵ Sequence State Actions

Get a Collection of Sequence States

SecuritybearerAuth and s2sAuthToken
Responses
200

OK

422

JSON error message

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


422
JSON error message


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


422
JSON error message


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


404
Not Found


get/sequenceStates/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Finish
Member Action


Finishes an active sequence state.


SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


422
JSON error message


post/sequenceStates/{id}/actions/finish
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Pause
Member Action


Pauses an active sequence state.


SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


422
JSON error message


post/sequenceStates/{id}/actions/pause
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Resume
Member Action


Resumes a paused sequence state.


SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


422
JSON error message


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