Sequence

Leverage emailing within Sequences to engage each individual persona more effectively, and queue up the right actions at the right time.

automationPercentage
number <float>

The percentage of "auto_email" sequence steps in this sequence.

bounceCount
integer

The total count of bounced mailings during this sequence.

clickCount
integer

The total count of clicked mailings from this sequence.

createdAt
string <date-time>

The date and time the sequence was created.

deliverCount
integer

The total count of delivered mailings from this sequence.

description
string <= 1024 characters

A custom description for the sequence.

durationInDays
integer

The total number of days it takes to get through this sequence.

enabled
boolean

A boolean value determining whether the sequence is enabled or not.

enabledAt
string <date-time>

The date and time the sequence was enabled, or null if currently disabled.

failureCount
integer

The total count of failed mailings from this sequence.

finishOnReply
boolean

Deprecated. This boolean value exists only to maintain backward compatibility and primaryReplyAction should be used instead. True if primaryReplyAction is "finish", false otherwise.

lastUsedAt
string <date-time>

The date and time the sequence was last used.

locked
boolean

A boolean value determining whether the sequence is locked or not.

lockedAt
string <date-time>

The date and time the sequence was locked, or null if currently unlocked.

maxActivations
integer

The maximum number of prospects that can be associated with the sequence. Only applies if the sequence type is "date".

name
string <= 255 characters

The name or the sequence.

negativeReplyCount
integer

The total count of negative reply mailings from this sequence.

neutralReplyCount
integer

The total count of neutral reply mailings from this sequence.

numContactedProspects
integer

The total count of prospects who have been either called or emailed.

numRepliedProspects
integer

The total count of prospects who have been marked as replied.

openCount
integer

The total count of opened mailings from this sequence.

optOutCount
integer

The total count of opted out mailings from this sequence.

positiveReplyCount
integer

The total count of positive reply mailings from this sequence.

primaryReplyAction
string <= 4 characters

The action to take when the primary prospect replies. Must be one of "finish", "continue", or "pause".

primaryReplyPauseDuration
integer

The duration in seconds to pause for (before automatically finishing) after a reply from the primary prospect if the primaryReplyAction is "pause".

replyCount
integer

The total count of replied mailings from this sequence.

salesMotion
string <= 255 characters

The sales engagement type of the sequence.

scheduleCount
integer

The total count of scheduled mailings from this sequence.

scheduleIntervalType
string <= 255 characters

The schedule interval type must be either "calendar" or "schedule"

secondaryReplyAction
string <= 4 characters

The action to take when someone other than the primary prospect replies. Must be one of "finish", "continue", or "pause".

secondaryReplyPauseDuration
integer

The duration in seconds to pause for (before automatically finishing) after a reply from anyone other than the primary prospect if the secondaryReplyAction is "pause".

sequenceStepCount
integer

The total number of sequence steps in this sequence.

sequenceType
string <= 255 characters

The sequence type must be either "date" or "interval".

shareType
string <= 255 characters

The sequence share type must be either "private", "read_only" or "shared".

tags
Array of strings

A list of tag values associated with the sequence (e.g. ["Tier 1", "Inbound Leads"])

throttleCapacity
integer

The maximum number of associated sequence states per user that can be active at a one time.

throttleMaxAddsPerDay
integer

The maximum number of associated sequence states per user that can be added to the sequence each day.

throttlePaused
boolean

A boolean value determining whether the throttling of sequence states is paused or not.

throttlePausedAt
string <date-time>

The date and time the sequence state throttling was paused, or null if not currently paused.

transactional
boolean

A boolean value determining whether prospect opt out preferences are respected. Intended only for non-marketing sequences.

updatedAt
string <date-time>

The date and time the sequence was last updated.

{
  • "automationPercentage": 0,
  • "bounceCount": 0,
  • "clickCount": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "deliverCount": 0,
  • "description": "string",
  • "durationInDays": 0,
  • "enabled": true,
  • "enabledAt": "2019-08-24T14:15:22Z",
  • "failureCount": 0,
  • "finishOnReply": true,
  • "lastUsedAt": "2019-08-24T14:15:22Z",
  • "locked": true,
  • "lockedAt": "2019-08-24T14:15:22Z",
  • "maxActivations": 0,
  • "name": "string",
  • "negativeReplyCount": 0,
  • "neutralReplyCount": 0,
  • "numContactedProspects": 0,
  • "numRepliedProspects": 0,
  • "openCount": 0,
  • "optOutCount": 0,
  • "positiveReplyCount": 0,
  • "primaryReplyAction": "stri",
  • "primaryReplyPauseDuration": 0,
  • "replyCount": 0,
  • "salesMotion": "string",
  • "scheduleCount": 0,
  • "scheduleIntervalType": "string",
  • "secondaryReplyAction": "stri",
  • "secondaryReplyPauseDuration": 0,
  • "sequenceStepCount": 0,
  • "sequenceType": "string",
  • "shareType": "string",
  • "tags": [
    ],
  • "throttleCapacity": 0,
  • "throttleMaxAddsPerDay": 0,
  • "throttlePaused": true,
  • "throttlePausedAt": "2019-08-24T14:15:22Z",
  • "transactional": true,
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Sequence Relationships

Array of links (object) (call)

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

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

The content categories (collections) of the sequence. You can use only the attribute id to filter sequences by contentCategoryMemberships (e.g. filter[contentCategoryMemberships][id]=X).

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

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

Array of links (object) (mailing)

The associated mailings. Relationship mailings cannot be used as a filter.

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

The owner of the sequence. You can use attributes id, email, firstName and lastName to filter sequences by owner (e.g. filter[owner][id]=X).

data (object) or links (object) (ruleset)

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

Array of links (object) (sequenceState)

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

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

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

Array of links (object) (task)

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

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

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

{
  • "calls": [
    ],
  • "contentCategoryMemberships": [
    ],
  • "creator": {
    },
  • "mailings": [
    ],
  • "owner": {
    },
  • "ruleset": {
    },
  • "sequenceStates": [
    ],
  • "sequenceSteps": [
    ],
  • "tasks": [
    ],
  • "updater": {
    }
}

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

Get a Collection of Sequences

SecuritybearerAuth and s2sAuthToken
Responses
200

OK

422

JSON error message

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


422
JSON error message


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


422
JSON error message


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


404
Not Found


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


422
JSON error message


patch/sequences/{id}
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Activate
Member Action


Enables the sequence.


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


422
JSON error message


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


Disables the sequence.


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


422
JSON error message


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