A descriptor of a currently sequenced prospect, which includes relationships to its sequence, prospect and user.
activeAt | string or null <date-time> The date and time the sequence state was last active. |
bounceCount | integer or null The total count of bounced mailings during this sequence state. |
callCompletedAt | string or null <date-time>
The date and time the sequence state last had a call completed. |
clickCount | integer or null
The total count of clicked mailings from this sequence state. |
createdAt | string or null <date-time>
The date and time the sequence state was created. |
deliverCount | integer or null
The total count of delivered mailings from this sequence state. |
errorReason | string or null <= 255 characters The reason for the most recent error. |
failureCount | integer or null The total count of failed mailings from this sequence state. |
negativeReplyCount | integer or null The total count of negative reply mailings from this sequence state. |
neutralReplyCount | integer or null The total count of neutral reply mailings from this sequence state. |
openCount | integer or null
The total count of opened mailings from this sequence state. |
optOutCount | integer or null The total count of opted out mailings from this sequence state. |
pauseReason | string or null <= 255 characters
The reason for the most recent pause. |
positiveReplyCount | integer or null The total count of positive reply mailings from this sequence state. |
repliedAt | string or null <date-time>
The date and time the sequence state last had a mailing reply. |
replyCount | integer or null
The total count of replied mailings from this sequence state. |
scheduleCount | integer or null The total count of scheduled mailings from this sequence state. |
state | string or null <= 255 characters
The current state of the sequence state. |
stateChangedAt | string or null <date-time>
The date and time the sequence state’s state last changed. |
updatedAt | string or null <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"
}
object 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). | |
object Any undelivered mailings associated with the current sequence step. Relationship activeStepMailings cannot be used as a filter. | |
object Any incomplete tasks associated with the current sequence step. Relationship activeStepTasks cannot be used as a filter. | |
object The batch item associated with this creation, if one exists. | |
object 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). | |
object The creator of the sequence state. Relationship creator cannot be used as a filter. | |
object 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). | |
object The mailings associated with the sequence state. Relationship mailings cannot be used as a filter. | |
object The associated opportunity. You can use only the attribute id to filter sequenceStates by opportunity (e.g. filter[opportunity][id]=X). | |
object 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). | |
object The sequence this prospect is engaged in. You can use any filterable attribute of sequence. | |
object Additional recipients associated with this sequence state. | |
object The current sequence step the prospect is in. You can use any filterable attribute of sequenceStep. | |
object 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). | |
object The user managing this sequence state. |
{- "activeStepMailings": {
- "data": [
- {
- "id": 0,
- "type": "mailing"
}
],
}, - "batchItemCreator": {
- "data": {
- "id": 0,
- "type": "batchItem"
},
}, - "opportunity": {
- "data": {
- "id": 0,
- "type": "opportunity"
},
}, - "sequenceStateRecipients": {
- "data": [
- {
- "id": 0,
- "type": "sequenceStateRecipient"
}
],
}, - "sequenceStep": {
- "data": {
- "id": 0,
- "type": "sequenceStep"
},
},
}
METADATA NAME | DESCRIPTION | QUERY PARAM |
---|---|---|
canDelete | A boolean value indicating whether the current API user has delete access to this resource. | provideAuthorizationMeta |
OK
JSON error message
{- "data": [
- {
- "attributes": {
- "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"
}, - "id": 0,
- "relationships": {
- "activeStepMailings": {
- "data": [
- {
- "id": 0,
- "type": "mailing"
}
],
}, - "batchItemCreator": {
- "data": {
- "id": 0,
- "type": "batchItem"
},
}, - "opportunity": {
- "data": {
- "id": 0,
- "type": "opportunity"
},
}, - "sequenceStateRecipients": {
- "data": [
- {
- "id": 0,
- "type": "sequenceStateRecipient"
}
],
}, - "sequenceStep": {
- "data": {
- "id": 0,
- "type": "sequenceStep"
},
},
}, - "type": "string"
}
]
}
object |
Created
JSON error message
{- "data": {
- "attributes": {
- "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"
}, - "relationships": {
- "activeStepMailings": {
- "data": [
- {
- "id": 0,
- "type": "mailing"
}
],
}, - "batchItemCreator": {
- "data": {
- "id": 0,
- "type": "batchItem"
},
}, - "opportunity": {
- "data": {
- "id": 0,
- "type": "opportunity"
},
}, - "sequenceStateRecipients": {
- "data": [
- {
- "id": 0,
- "type": "sequenceStateRecipient"
}
],
}, - "sequenceStep": {
- "data": {
- "id": 0,
- "type": "sequenceStep"
},
},
}, - "type": "string"
}
}
{- "data": {
- "attributes": {
- "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"
}, - "id": 0,
- "relationships": {
- "activeStepMailings": {
- "data": [
- {
- "id": 0,
- "type": "mailing"
}
],
}, - "batchItemCreator": {
- "data": {
- "id": 0,
- "type": "batchItem"
},
}, - "opportunity": {
- "data": {
- "id": 0,
- "type": "opportunity"
},
}, - "sequenceStateRecipients": {
- "data": [
- {
- "id": 0,
- "type": "sequenceStateRecipient"
}
],
}, - "sequenceStep": {
- "data": {
- "id": 0,
- "type": "sequenceStep"
},
},
}, - "type": "string"
}
}
{- "data": {
- "attributes": {
- "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"
}, - "id": 0,
- "relationships": {
- "activeStepMailings": {
- "data": [
- {
- "id": 0,
- "type": "mailing"
}
],
}, - "batchItemCreator": {
- "data": {
- "id": 0,
- "type": "batchItem"
},
}, - "opportunity": {
- "data": {
- "id": 0,
- "type": "opportunity"
},
}, - "sequenceStateRecipients": {
- "data": [
- {
- "id": 0,
- "type": "sequenceStateRecipient"
}
],
}, - "sequenceStep": {
- "data": {
- "id": 0,
- "type": "sequenceStep"
},
},
}, - "type": "string"
}
}
Finishes an active sequence state.
OK
JSON error message
{- "data": {
- "attributes": {
- "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"
}, - "id": 0,
- "relationships": {
- "activeStepMailings": {
- "data": [
- {
- "id": 0,
- "type": "mailing"
}
],
}, - "batchItemCreator": {
- "data": {
- "id": 0,
- "type": "batchItem"
},
}, - "opportunity": {
- "data": {
- "id": 0,
- "type": "opportunity"
},
}, - "sequenceStateRecipients": {
- "data": [
- {
- "id": 0,
- "type": "sequenceStateRecipient"
}
],
}, - "sequenceStep": {
- "data": {
- "id": 0,
- "type": "sequenceStep"
},
},
}, - "type": "string"
}
}
Pauses an active sequence state.
OK
JSON error message
{- "data": {
- "attributes": {
- "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"
}, - "id": 0,
- "relationships": {
- "activeStepMailings": {
- "data": [
- {
- "id": 0,
- "type": "mailing"
}
],
}, - "batchItemCreator": {
- "data": {
- "id": 0,
- "type": "batchItem"
},
}, - "opportunity": {
- "data": {
- "id": 0,
- "type": "opportunity"
},
}, - "sequenceStateRecipients": {
- "data": [
- {
- "id": 0,
- "type": "sequenceStateRecipient"
}
],
}, - "sequenceStep": {
- "data": {
- "id": 0,
- "type": "sequenceStep"
},
},
}, - "type": "string"
}
}
Resumes a paused sequence state.
OK
JSON error message
{- "data": {
- "attributes": {
- "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"
}, - "id": 0,
- "relationships": {
- "activeStepMailings": {
- "data": [
- {
- "id": 0,
- "type": "mailing"
}
],
}, - "batchItemCreator": {
- "data": {
- "id": 0,
- "type": "batchItem"
},
}, - "opportunity": {
- "data": {
- "id": 0,
- "type": "opportunity"
},
}, - "sequenceStateRecipients": {
- "data": [
- {
- "id": 0,
- "type": "sequenceStateRecipient"
}
],
}, - "sequenceStep": {
- "data": {
- "id": 0,
- "type": "sequenceStep"
},
},
}, - "type": "string"
}
}