A descriptor of a single step within an automated sequence.
bounceCount | integer or null The total count of bounced mailings during this sequence step. |
clickCount | integer or null The total count of clicked mailings from this sequence step. |
createdAt | string or null <date-time>
The date and time the sequence step was created. |
date | string or null <date>
The date this step will activate; only applicable to date-based sequences. |
deliverCount | integer or null The total count of delivered mailings from this sequence step. |
displayName | string or null A human-readable display name that captures the step’s type and order. |
failureCount | integer or null The total count of failed mailings from this sequence step. |
interval | integer or null The interval (in seconds) until this step will activate; only applicable to interval-based sequences. |
negativeReplyCount | integer or null The total count of negative reply mailings from this sequence step. |
neutralReplyCount | integer or null The total count of neutral reply mailings from this sequence step. |
openCount | integer or null The total count of opened mailings from this sequence step. |
optOutCount | integer or null The total count of opted out mailings from this sequence step. |
order | integer or null
The step’s display order within its sequence. |
positiveReplyCount | integer or null The total count of positive reply mailings from this sequence step. |
replyCount | integer or null The total count of replied mailings from this sequence step. |
scheduleCount | integer or null The total count of scheduled mailings from this sequence step. |
stepType | string or null <= 255 characters
The step’s type; must be "auto_email", "manual_email", "call" or "task". |
taskAutoskipDelay | integer or null The optional interval (in seconds) from when tasks created by this sequence step are overdue until they are automatically skipped. |
taskNote | string or null <= 65535 characters An optional note to associate with created tasks. |
updatedAt | string or null <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"
}
object 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). | |
object 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). | |
object The creator of the sequence step. You can use only the attribute id to filter sequenceSteps by creator (e.g. filter[creator][id]=X). | |
object The mailings associated with the sequence step. Relationship mailings cannot be used as a filter. | |
object The associated schedule | |
object The associated sequence. You can use attributes id, enabledAt and name to filter sequenceSteps by sequence (e.g. filter[sequence][id]=X). | |
object The sequence templates in use by this sequence step. You can use any filterable attribute of sequenceTemplates. | |
object The associated task priority. You can use only the attribute id to filter sequenceSteps by taskPriority (e.g. filter[taskPriority][id]=X). | |
object 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). | |
object 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": {
- "data": {
- "id": 0,
- "type": "callPurpose"
},
}, - "sequenceTemplates": {
- "data": [
- {
- "id": 0,
- "type": "sequenceTemplate"
}
],
}, - "taskPriority": {
- "data": {
- "id": 0,
- "type": "taskPriority"
},
},
}
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 |
{- "data": [
- {
- "attributes": {
- "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"
}, - "id": 0,
- "relationships": {
- "callPurpose": {
- "data": {
- "id": 0,
- "type": "callPurpose"
},
}, - "sequenceTemplates": {
- "data": [
- {
- "id": 0,
- "type": "sequenceTemplate"
}
],
}, - "taskPriority": {
- "data": {
- "id": 0,
- "type": "taskPriority"
},
},
}, - "type": "string"
}
]
}
object |
Created
JSON error message
{- "data": {
- "attributes": {
- "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"
}, - "relationships": {
- "callPurpose": {
- "data": {
- "id": 0,
- "type": "callPurpose"
},
}, - "sequenceTemplates": {
- "data": [
- {
- "id": 0,
- "type": "sequenceTemplate"
}
],
}, - "taskPriority": {
- "data": {
- "id": 0,
- "type": "taskPriority"
},
},
}, - "type": "string"
}
}
{- "data": {
- "attributes": {
- "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"
}, - "id": 0,
- "relationships": {
- "callPurpose": {
- "data": {
- "id": 0,
- "type": "callPurpose"
},
}, - "sequenceTemplates": {
- "data": [
- {
- "id": 0,
- "type": "sequenceTemplate"
}
],
}, - "taskPriority": {
- "data": {
- "id": 0,
- "type": "taskPriority"
},
},
}, - "type": "string"
}
}
{- "data": {
- "attributes": {
- "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"
}, - "id": 0,
- "relationships": {
- "callPurpose": {
- "data": {
- "id": 0,
- "type": "callPurpose"
},
}, - "sequenceTemplates": {
- "data": [
- {
- "id": 0,
- "type": "sequenceTemplate"
}
],
}, - "taskPriority": {
- "data": {
- "id": 0,
- "type": "taskPriority"
},
},
}, - "type": "string"
}
}
{- "data": {
- "attributes": {
- "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"
}, - "id": 0,
- "relationships": {
- "callPurpose": {
- "data": {
- "id": 0,
- "type": "callPurpose"
},
}, - "sequenceTemplates": {
- "data": [
- {
- "id": 0,
- "type": "sequenceTemplate"
}
],
}, - "taskPriority": {
- "data": {
- "id": 0,
- "type": "taskPriority"
},
},
}, - "type": "string"
}
}
{- "data": {
- "attributes": {
- "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"
}, - "id": 0,
- "relationships": {
- "callPurpose": {
- "data": {
- "id": 0,
- "type": "callPurpose"
},
}, - "sequenceTemplates": {
- "data": [
- {
- "id": 0,
- "type": "sequenceTemplate"
}
],
}, - "taskPriority": {
- "data": {
- "id": 0,
- "type": "taskPriority"
},
},
}, - "type": "string"
}
}