Sequences
Time-based drips: ordered steps (delay, message, optional condition) sent to enrolled contacts on one account; contacts exit on reply or unsubscribe.
List sequences
/sequencesTry it with MCPAsk your agent to call list-sequences (toolset sequences)Set up MCP
Query parameters
pageintegerdefault: 1Page number
≥ 1
limitintegerdefault: 20Items per page (max 100)
1–100
sortstringcreated_atname
orderstringascdesc
matchstringCombine filters with AND (default) or OR
allor
profile_idstringaccount_idstringstatusstringplatformstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 17 item attributes
objectstringsequence
idstringprofile_idstring | nullaccount_idstring | nullaccount_namestring | nullplatformstringnamestringdescriptionstring | nullstatusstringdraftactivepaused
stepsarray of objectShow 4 item attributes
orderintegerdelay_minutesintegermessageobject | nullShow 3 child attributes
textstring | nullattachmentsarray of objectShow 3 item attributes
typestringurlstringfilenamestring | nullmessage_tagstring | nullconditionobject | nullShow 4 child attributes
variablestringoperatorstringvalueanyon_falsestringsteps_countintegermessage_previewstring | nullexit_on_replybooleanexit_on_unsubscribebooleanstatsobjectShow 5 child attributes
total_enrolledintegeractiveintegerpausedintegercompletedintegerexitedintegercreated_atstring (date-time) | nullupdated_atstring (date-time) | nullpageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
{
"object": "list",
"data": [
{
"object": "sequence",
"id": "string",
"profile_id": "string",
"account_id": "string",
"account_name": "string",
"platform": "string",
"name": "string",
"description": "string",
"status": "draft",
"steps": [
{
"order": 1,
"delay_minutes": 1,
"message": {
"text": null,
"attachments": [],
"message_tag": null
},
"condition": {
"variable": null,
"operator": null,
"value": null,
"on_false": null
}
}
],
"steps_count": 1,
"message_preview": "string",
"exit_on_reply": true,
"exit_on_unsubscribe": true,
"stats": {
"total_enrolled": 1,
"active": 1,
"paused": 1,
"completed": 1,
"exited": 1
},
"created_at": "2026-10-13T09:00:00.000Z",
"updated_at": "2026-10-13T09:00:00.000Z"
}
],
"page": 1,
"limit": 1,
"total": 1,
"has_more": true,
"next_page_url": "https://example.com",
"previous_page_url": "https://example.com"
}Create a sequence
/sequencesTry it with MCPAsk your agent to call create-sequence (toolset sequences)Set up MCP
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
profile_idstringaccount_idstringrequiredplatformstringinstagramfacebookxblueskyredditdiscordmastodontiktoktwitter
namestringrequired1–200 characters
descriptionstring | null≤ 2000 characters
stepsarray of object≤ 50 items
Show 4 item attributes
orderintegerrequired1–1000
delay_minutesintegerrequired0–525600
messageobject | nullShow 3 child attributes
textstring | null≤ 4096 characters
attachmentsarray of object≤ 10 items
Show 3 item attributes
typestringimagevideoaudiofile
urlstringrequired1–2048 characters
filenamestring≤ 255 characters
message_tagstring | nullHUMAN_AGENTCONFIRMED_EVENT_UPDATEPOST_PURCHASE_UPDATEACCOUNT_UPDATE
conditionobject | nullShow 4 child attributes
variablestringrequired1–200 characters
operatorstringrequiredvalueanyon_falsestringskipexit
exit_on_replybooleanexit_on_unsubscribebooleanReturns object
objectstringsequence
idstringprofile_idstring | nullaccount_idstring | nullaccount_namestring | nullplatformstringnamestringdescriptionstring | nullstatusstringdraftactivepaused
stepsarray of objectShow 4 item attributes
orderintegerdelay_minutesintegermessageobject | nullShow 3 child attributes
textstring | nullattachmentsarray of objectShow 3 item attributes
typestringurlstringfilenamestring | nullmessage_tagstring | nullconditionobject | nullShow 4 child attributes
variablestringoperatorstringvalueanyon_falsestringsteps_countintegermessage_previewstring | nullexit_on_replybooleanexit_on_unsubscribebooleanstatsobjectShow 5 child attributes
total_enrolledintegeractiveintegerpausedintegercompletedintegerexitedintegercreated_atstring (date-time) | nullupdated_atstring (date-time) | nullResponses
{
"object": "sequence",
"id": "string",
"profile_id": "string",
"account_id": "string",
"account_name": "string",
"platform": "string",
"name": "string",
"description": "string",
"status": "draft",
"steps": [
{
"order": 1,
"delay_minutes": 1,
"message": {
"text": "string",
"attachments": [
{
"type": null,
"url": null,
"filename": null
}
],
"message_tag": "string"
},
"condition": {
"variable": "string",
"operator": "string",
"value": null,
"on_false": "string"
}
}
],
"steps_count": 1,
"message_preview": "string",
"exit_on_reply": true,
"exit_on_unsubscribe": true,
"stats": {
"total_enrolled": 1,
"active": 1,
"paused": 1,
"completed": 1,
"exited": 1
},
"created_at": "2026-10-13T09:00:00.000Z",
"updated_at": "2026-10-13T09:00:00.000Z"
}Get a sequence
/sequences/{id}Try it with MCPAsk your agent to call get-sequence (toolset sequences)Set up MCP
Path parameters
idstringrequiredsequence id (seq_…)
1–80 characters
Returns object
objectstringsequence
idstringprofile_idstring | nullaccount_idstring | nullaccount_namestring | nullplatformstringnamestringdescriptionstring | nullstatusstringdraftactivepaused
stepsarray of objectShow 4 item attributes
orderintegerdelay_minutesintegermessageobject | nullShow 3 child attributes
textstring | nullattachmentsarray of objectShow 3 item attributes
typestringurlstringfilenamestring | nullmessage_tagstring | nullconditionobject | nullShow 4 child attributes
variablestringoperatorstringvalueanyon_falsestringsteps_countintegermessage_previewstring | nullexit_on_replybooleanexit_on_unsubscribebooleanstatsobjectShow 5 child attributes
total_enrolledintegeractiveintegerpausedintegercompletedintegerexitedintegercreated_atstring (date-time) | nullupdated_atstring (date-time) | nullResponses
{
"object": "sequence",
"id": "string",
"profile_id": "string",
"account_id": "string",
"account_name": "string",
"platform": "string",
"name": "string",
"description": "string",
"status": "draft",
"steps": [
{
"order": 1,
"delay_minutes": 1,
"message": {
"text": "string",
"attachments": [
{
"type": null,
"url": null,
"filename": null
}
],
"message_tag": "string"
},
"condition": {
"variable": "string",
"operator": "string",
"value": null,
"on_false": "string"
}
}
],
"steps_count": 1,
"message_preview": "string",
"exit_on_reply": true,
"exit_on_unsubscribe": true,
"stats": {
"total_enrolled": 1,
"active": 1,
"paused": 1,
"completed": 1,
"exited": 1
},
"created_at": "2026-10-13T09:00:00.000Z",
"updated_at": "2026-10-13T09:00:00.000Z"
}Update a sequence
/sequences/{id}steps can only be replaced while draft or paused (409 sequence_not_editable).
Try it with MCPAsk your agent to call update-sequence (toolset sequences)Set up MCP
Path parameters
idstringrequiredsequence id (seq_…)
1–80 characters
Body object
namestring1–200 characters
descriptionstring | null≤ 2000 characters
stepsarray of object≤ 50 items
Show 4 item attributes
orderintegerrequired1–1000
delay_minutesintegerrequired0–525600
messageobject | nullShow 3 child attributes
textstring | null≤ 4096 characters
attachmentsarray of object≤ 10 items
Show 3 item attributes
typestringimagevideoaudiofile
urlstringrequired1–2048 characters
filenamestring≤ 255 characters
message_tagstring | nullHUMAN_AGENTCONFIRMED_EVENT_UPDATEPOST_PURCHASE_UPDATEACCOUNT_UPDATE
conditionobject | nullShow 4 child attributes
variablestringrequired1–200 characters
operatorstringrequiredvalueanyon_falsestringskipexit
exit_on_replybooleanexit_on_unsubscribebooleanReturns object
objectstringsequence
idstringprofile_idstring | nullaccount_idstring | nullaccount_namestring | nullplatformstringnamestringdescriptionstring | nullstatusstringdraftactivepaused
stepsarray of objectShow 4 item attributes
orderintegerdelay_minutesintegermessageobject | nullShow 3 child attributes
textstring | nullattachmentsarray of objectShow 3 item attributes
typestringurlstringfilenamestring | nullmessage_tagstring | nullconditionobject | nullShow 4 child attributes
variablestringoperatorstringvalueanyon_falsestringsteps_countintegermessage_previewstring | nullexit_on_replybooleanexit_on_unsubscribebooleanstatsobjectShow 5 child attributes
total_enrolledintegeractiveintegerpausedintegercompletedintegerexitedintegercreated_atstring (date-time) | nullupdated_atstring (date-time) | nullResponses
{
"object": "sequence",
"id": "string",
"profile_id": "string",
"account_id": "string",
"account_name": "string",
"platform": "string",
"name": "string",
"description": "string",
"status": "draft",
"steps": [
{
"order": 1,
"delay_minutes": 1,
"message": {
"text": "string",
"attachments": [
{
"type": null,
"url": null,
"filename": null
}
],
"message_tag": "string"
},
"condition": {
"variable": "string",
"operator": "string",
"value": null,
"on_false": "string"
}
}
],
"steps_count": 1,
"message_preview": "string",
"exit_on_reply": true,
"exit_on_unsubscribe": true,
"stats": {
"total_enrolled": 1,
"active": 1,
"paused": 1,
"completed": 1,
"exited": 1
},
"created_at": "2026-10-13T09:00:00.000Z",
"updated_at": "2026-10-13T09:00:00.000Z"
}Delete a sequence
/sequences/{id}Live enrollments exit with sequence_deleted.
Try it with MCPAsk your agent to call delete-sequence (toolset sequences)Set up MCP
Path parameters
idstringrequiredsequence id (seq_…)
1–80 characters
Returns object
objectstringrequiredsequence
idstringrequireddeletedbooleanrequiredResponses
{
"object": "sequence",
"id": "string",
"deleted": true
}Activate a sequence
/sequences/{id}/activatePaused enrollments resume (overdue steps are sent now).
Try it with MCPAsk your agent to call activate-sequence (toolset sequences)Set up MCP
Path parameters
idstringrequiredsequence id (seq_…)
1–80 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Returns object
objectstringsequence
idstringprofile_idstring | nullaccount_idstring | nullaccount_namestring | nullplatformstringnamestringdescriptionstring | nullstatusstringdraftactivepaused
stepsarray of objectShow 4 item attributes
orderintegerdelay_minutesintegermessageobject | nullShow 3 child attributes
textstring | nullattachmentsarray of objectShow 3 item attributes
typestringurlstringfilenamestring | nullmessage_tagstring | nullconditionobject | nullShow 4 child attributes
variablestringoperatorstringvalueanyon_falsestringsteps_countintegermessage_previewstring | nullexit_on_replybooleanexit_on_unsubscribebooleanstatsobjectShow 5 child attributes
total_enrolledintegeractiveintegerpausedintegercompletedintegerexitedintegercreated_atstring (date-time) | nullupdated_atstring (date-time) | nullResponses
{
"object": "sequence",
"id": "string",
"profile_id": "string",
"account_id": "string",
"account_name": "string",
"platform": "string",
"name": "string",
"description": "string",
"status": "draft",
"steps": [
{
"order": 1,
"delay_minutes": 1,
"message": {
"text": "string",
"attachments": [
{
"type": null,
"url": null,
"filename": null
}
],
"message_tag": "string"
},
"condition": {
"variable": "string",
"operator": "string",
"value": null,
"on_false": "string"
}
}
],
"steps_count": 1,
"message_preview": "string",
"exit_on_reply": true,
"exit_on_unsubscribe": true,
"stats": {
"total_enrolled": 1,
"active": 1,
"paused": 1,
"completed": 1,
"exited": 1
},
"created_at": "2026-10-13T09:00:00.000Z",
"updated_at": "2026-10-13T09:00:00.000Z"
}Pause a sequence
/sequences/{id}/pauseTry it with MCPAsk your agent to call pause-sequence (toolset sequences)Set up MCP
Path parameters
idstringrequiredsequence id (seq_…)
1–80 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Returns object
objectstringsequence
idstringprofile_idstring | nullaccount_idstring | nullaccount_namestring | nullplatformstringnamestringdescriptionstring | nullstatusstringdraftactivepaused
stepsarray of objectShow 4 item attributes
orderintegerdelay_minutesintegermessageobject | nullShow 3 child attributes
textstring | nullattachmentsarray of objectShow 3 item attributes
typestringurlstringfilenamestring | nullmessage_tagstring | nullconditionobject | nullShow 4 child attributes
variablestringoperatorstringvalueanyon_falsestringsteps_countintegermessage_previewstring | nullexit_on_replybooleanexit_on_unsubscribebooleanstatsobjectShow 5 child attributes
total_enrolledintegeractiveintegerpausedintegercompletedintegerexitedintegercreated_atstring (date-time) | nullupdated_atstring (date-time) | nullResponses
{
"object": "sequence",
"id": "string",
"profile_id": "string",
"account_id": "string",
"account_name": "string",
"platform": "string",
"name": "string",
"description": "string",
"status": "draft",
"steps": [
{
"order": 1,
"delay_minutes": 1,
"message": {
"text": "string",
"attachments": [
{
"type": null,
"url": null,
"filename": null
}
],
"message_tag": "string"
},
"condition": {
"variable": "string",
"operator": "string",
"value": null,
"on_false": "string"
}
}
],
"steps_count": 1,
"message_preview": "string",
"exit_on_reply": true,
"exit_on_unsubscribe": true,
"stats": {
"total_enrolled": 1,
"active": 1,
"paused": 1,
"completed": 1,
"exited": 1
},
"created_at": "2026-10-13T09:00:00.000Z",
"updated_at": "2026-10-13T09:00:00.000Z"
}Enroll contacts in a sequence
/sequences/{id}/enrollThe channel is the contact's subscribed channel on the sequence account unless channel_ids pin one. Already-enrolled contacts are skipped.
Try it with MCPAsk your agent to call enroll-sequence-contacts (toolset sequences)Set up MCP
Path parameters
idstringrequiredsequence id (seq_…)
1–80 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
contact_idsarray of stringrequired1–1000 items
channel_idsarray of string≤ 1000 items
Returns object
objectstringsequence_enroll_result
enrolledintegerskippedintegerfailedintegerresultsarray of objectShow 4 item attributes
contact_idstringsuccessbooleanenrollment_idstring | nullerrorstring | nullResponses
{
"object": "sequence_enroll_result",
"enrolled": 1,
"skipped": 1,
"failed": 1,
"results": [
{
"contact_id": "string",
"success": true,
"enrollment_id": "string",
"error": "string"
}
]
}Unenroll a contact
/sequences/{id}/enroll/{contactId}Try it with MCPAsk your agent to call unenroll-sequence-contact (toolset sequences)Set up MCP
Path parameters
idstringrequiredsequence id (seq_…)
1–80 characters
contactIdstringrequiredcontact id (con_…)
1–80 characters
Returns object
objectstringsequence_enrollment
idstringsequence_idstringcontact_idstring | nullchannel_idstring | nullcontact_namestring | nullplatform_identifierstring | nullstatusstringactivepausedcompletedexited
exit_reasonstring | nullcurrent_step_indexintegersteps_sentintegernext_step_atstring (date-time) | nulllast_step_sent_atstring (date-time) | nulllast_errorstring | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullResponses
{
"object": "sequence_enrollment",
"id": "string",
"sequence_id": "string",
"contact_id": "string",
"channel_id": "string",
"contact_name": "string",
"platform_identifier": "string",
"status": "active",
"exit_reason": "string",
"current_step_index": 1,
"steps_sent": 1,
"next_step_at": "2026-10-13T09:00:00.000Z",
"last_step_sent_at": "2026-10-13T09:00:00.000Z",
"last_error": "string",
"created_at": "2026-10-13T09:00:00.000Z",
"updated_at": "2026-10-13T09:00:00.000Z"
}List sequence enrollments
/sequences/{id}/enrollmentsTry it with MCPAsk your agent to call list-sequence-enrollments (toolset sequences)Set up MCP
Path parameters
idstringrequiredsequence id (seq_…)
1–80 characters
Query parameters
pageintegerdefault: 1Page number
≥ 1
limitintegerdefault: 20Items per page (max 100)
1–100
sortstringcreated_atnext_step_at
orderstringascdesc
matchstringCombine filters with AND (default) or OR
allor
statusstringcontact_idstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 16 item attributes
objectstringsequence_enrollment
idstringsequence_idstringcontact_idstring | nullchannel_idstring | nullcontact_namestring | nullplatform_identifierstring | nullstatusstringactivepausedcompletedexited
exit_reasonstring | nullcurrent_step_indexintegersteps_sentintegernext_step_atstring (date-time) | nulllast_step_sent_atstring (date-time) | nulllast_errorstring | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullpageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
{
"object": "list",
"data": [
{
"object": "sequence_enrollment",
"id": "string",
"sequence_id": "string",
"contact_id": "string",
"channel_id": "string",
"contact_name": "string",
"platform_identifier": "string",
"status": "active",
"exit_reason": "string",
"current_step_index": 1,
"steps_sent": 1,
"next_step_at": "2026-10-13T09:00:00.000Z",
"last_step_sent_at": "2026-10-13T09:00:00.000Z",
"last_error": "string",
"created_at": "2026-10-13T09:00:00.000Z",
"updated_at": "2026-10-13T09:00:00.000Z"
}
],
"page": 1,
"limit": 1,
"total": 1,
"has_more": true,
"next_page_url": "https://example.com",
"previous_page_url": "https://example.com"
}