Skip to Content
Tools referenceSequence contacts

Sequence contacts

ToolWhat it does
sequence_contact_mark_finishedMark selected sequence contacts finished with the chosen reason.
sequence_contact_pausePause selected contacts in one sequence.
sequence_contact_reattribute_mailboxMove selected enrollments to an eligible sending mailbox.
sequence_contact_removeRemove selected contacts from one sequence.
sequence_contact_resumeResume selected contacts in one sequence.
sequence_contacts_exportExport accessible contacts matching the canonical sequence filters.
sequence_contacts_searchFind contacts inside one sequence by status, step, mailbox, stage or engagement — who’s paused, who replied, who’s stuck.
sequence_enroll_contactsPreview, freeze and enroll a contact selection through the owner gate.

sequence_contact_mark_finished

Mark selected sequence contacts finished with the chosen reason.

Manually mark one or more contacts finished in a sequence (e.g. “he replied, mark him finished”), optionally across several sequences at once for the same contacts and with a reason that can trigger a stage-change side effect. Stops further sends to those contacts in this sequence.

EndpointPOST https://api.prospeo.io/api/v2/tools/sequence-contact-mark-finished
MCP toolsequence_contact_mark_finished on https://mcp.prospeo.io
EffectChanges data.
CreditsFree, uses no credits.
PermissionCreate & edit sequences (sequences.create_edit)
ConfirmationNot needed.
PaginationReturns one page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
sequence_oidstringNoPattern ^[0-9a-fA-F]{24}$.
saved_person_oidsarray of stringYesUp to 20000 items.
sequence_oidsarray of stringNoUp to 50 items.
reasonstring (enum)NoOne of: REPLIED, INTERESTED, UNSUBSCRIBED, OTHER.

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

sequence_contact_pause

Pause selected contacts in one sequence.

Pause one or more contacts at their current position in a sequence (row or bulk) — freezes their send clock without affecting the rest of the sequence.

EndpointPOST https://api.prospeo.io/api/v2/tools/sequence-contact-pause
MCP toolsequence_contact_pause on https://mcp.prospeo.io
EffectChanges data.
CreditsFree, uses no credits.
PermissionCreate & edit sequences (sequences.create_edit)
ConfirmationNot needed.
PaginationReturns one page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
sequence_oidstringYesMongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$.
saved_person_oidsarray of stringYesUp to 20000 items.

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

sequence_contact_reattribute_mailbox

Move selected enrollments to an eligible sending mailbox.

Re-assign which connected mailbox a set of contacts sends from going forward (e.g. mailbox rotation after one gets disconnected). Only an owner-eligible, ACTIVE mailbox can be chosen.

EndpointPOST https://api.prospeo.io/api/v2/tools/sequence-contact-reattribute-mailbox
MCP toolsequence_contact_reattribute_mailbox on https://mcp.prospeo.io
EffectChanges data.
CreditsFree, uses no credits.
PermissionCreate & edit sequences (sequences.create_edit)
ConfirmationNot needed.
PaginationReturns one page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
sequence_oidstringYesMongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$.
saved_person_oidsarray of stringYesUp to 20000 items.
mailbox_oidstringYesMongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$.

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

sequence_contact_remove

Remove selected contacts from one sequence.

Remove one or more contacts from a sequence (finishes the whole contact — no further steps will send to them).

EndpointPOST https://api.prospeo.io/api/v2/tools/sequence-contact-remove
MCP toolsequence_contact_remove on https://mcp.prospeo.io
EffectChanges data.
CreditsFree, uses no credits.
PermissionCreate & edit sequences (sequences.create_edit)
ConfirmationNot needed.
PaginationReturns one page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
sequence_oidstringYesMongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$.
saved_person_oidsarray of stringYesUp to 20000 items.

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

sequence_contact_resume

Resume selected contacts in one sequence.

Resume one or more contacts previously paused in a sequence; runs any advance that was queued while they were paused, which can send their next scheduled email right away.

EndpointPOST https://api.prospeo.io/api/v2/tools/sequence-contact-resume
MCP toolsequence_contact_resume on https://mcp.prospeo.io
EffectChanges data.
CreditsFree, uses no credits.
PermissionCreate & edit sequences (sequences.create_edit)
ConfirmationNot needed.
PaginationReturns one page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
sequence_oidstringYesMongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$.
saved_person_oidsarray of stringYesUp to 20000 items.

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

sequence_contacts_export

Export accessible contacts matching the canonical sequence filters.

Export a sequence’s Contacts tab (same filter surface as the listing) to a downloadable CSV.

EndpointPOST https://api.prospeo.io/api/v2/tools/sequence-contacts-export
MCP toolsequence_contacts_export on https://mcp.prospeo.io
EffectChanges data.
CreditsFree, uses no credits.
Permissionsequences.team.read (sequences.team.read)
ConfirmationNot needed.
PaginationReturns one page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
sequence_oidstringYesMongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$.
statusesarray of stringNo
master_statusstringNo
finished_reasonsarray of stringNo
finished_byarray of string or “automatic”NoUp to 500 items.
finished_afterstringNo
finished_beforestringNo
stage_idsarray of integerNo
stepsarray of integerNo
mailbox_oidsarray of stringNo
job_titlesarray of stringNo
contact_oidsarray of stringNo
last_contacted_afterstringNo
last_contacted_beforestringNo

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

Find contacts inside one sequence by status, step, mailbox, stage or engagement — who’s paused, who replied, who’s stuck.

Find contacts within a sequence by status, current step, mailbox, or engagement state (“who’s paused at step 3 on this mailbox”). Same underlying operation as sequence_contacts_list — this is the typed-filter/search framing of it.

EndpointPOST https://api.prospeo.io/api/v2/tools/sequence-contacts-search
MCP toolsequence_contacts_search on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
Permissionsequences.team.read (sequences.team.read)
ConfirmationNot needed.
PaginationPage-based: page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
sequence_oidstringYesThe sequence’s id. At most 64 characters. Length 1 to 64.
statusesarray of string (enum)NoRestrict to contacts currently on these ladder statuses. Up to 24 items. Items one of: ENRICHING, PAUSED, NO_EMAIL, INVALID_EMAIL, LIKELY_TO_BOUNCE, MISSING_DATA, NO_CREDITS, ENRICHMENT_FAILED, MISSING_SOCIAL_PROFILE, NO_MAILBOX_ASSIGNED, MAILBOX_DISCONNECTED, MAILBOX_PAUSED, EXCLUDED_DO_NOT_CONTACT, QUEUED, WAITING, WAITING_MANUAL_EMAIL_SCHEDULED, WAITING_OFFICE_HOURS, WAITING_OUT_OF_OFFICE, DELAYED_DAILY_LIMIT, DELAYED_MAILBOX_LIMIT, DELAYED_COMPANY_LIMIT, TASK_DUE, TASK_OVERDUE, FINISHED.
master_statusstring (enum)NoRestrict to the coarse ACTIVE (still moving) or SENT (received at least one email) bucket. One of: ACTIVE, SENT.
finished_reasonsarray of string (enum)NoRestrict to these finished-reason values (only meaningful together with statuses=[FINISHED]). Up to 16 items. Items one of: COMPLETED, REPLIED, COLLEAGUE_REPLIED, UNRESPONSIVE, STAGE_RULE, ACCOUNT_STAGE, UNSUBSCRIBED, BOUNCED, AUTO_REPLY, MARKED_FINISHED, REMOVED, STOPPED, SEND_FAILED, CALL_CONNECTED, MEETING_BOOKED, FORM_SUBMITTED, DNC.
stage_idsarray of integerNoRestrict to contacts on these CRM stage ids. At most 50. Up to 50 items.
stepsarray of integerNoRestrict to contacts currently at these 0-based step indexes. At most 15. Up to 15 items.
mailbox_oidsarray of stringNoRestrict to contacts sending from these mailboxes. At most 200 ids. Up to 200 items.
contact_oidsarray of stringNoRestrict to these specific contacts, by saved-person id. At most 200 ids. Up to 200 items.
last_contacted_afterstringNoOnly contacts last contacted at/after this time.
last_contacted_beforestringNoOnly contacts last contacted at/before this time.
pageintegerNo1-based page number. 25 rows per page. From 1 to any. Default 1.

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

sequence_enroll_contacts

Preview, freeze and enroll a contact selection through the owner gate.

Add contacts to a sequence from a saved selection, a list, or a live search selection through the existing preview, approval, and confirm gate flow. Enrollment itself is free; a live-search reveal and optional waterfall work may spend credits. Always disclose the preview-derived estimate and cap before confirm, and preserve owner errors in the result.

EndpointPOST https://api.prospeo.io/api/v2/tools/sequence-enroll-contacts
MCP toolsequence_enroll_contacts on https://mcp.prospeo.io
EffectChanges data.
CreditsFree, uses no credits.
Permissionsequences.team.read (sequences.team.read), Create & edit sequences (sequences.create_edit)
ConfirmationRecommended: MCP clients should confirm with the user before calling.
PaginationReturns one page.

Request

Send POST with your API key in the X-KEY header and a JSON body. Unknown fields and query parameters are rejected. The full JSON Schema is served with the tool list.

ParameterTypeRequiredDescription
saved_person_oidsarray of stringNoUp to 20000 items.
list_oidstringNo
person_oidsarray of stringNoUp to 20000 items.
select_typestringNo
filter_config_tokenstringNo
manually_excluded_person_oidsarray of stringNoUp to 20000 items.
cohortstringNoDefault "ALL".
skip_in_otherbooleanNoDefault false.
find_emailsbooleanNoDefault false.
find_mobilesbooleanNoDefault false.
enrich_mobilesbooleanNoDefault false.
sequence_oidstringNoPattern ^[0-9a-fA-F]{24}$.
namestringNoLength 0 to 200.
send_from_oidsarray of stringNoUp to 200 items.

Response

{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.

Last updated on