Sequence contacts
| Tool | What it does |
|---|---|
sequence_contact_mark_finished | Mark selected sequence contacts finished with the chosen reason. |
sequence_contact_pause | Pause selected contacts in one sequence. |
sequence_contact_reattribute_mailbox | Move selected enrollments to an eligible sending mailbox. |
sequence_contact_remove | Remove selected contacts from one sequence. |
sequence_contact_resume | Resume selected contacts in one sequence. |
sequence_contacts_export | Export accessible contacts matching the canonical sequence filters. |
sequence_contacts_search | Find contacts inside one sequence by status, step, mailbox, stage or engagement — who’s paused, who replied, who’s stuck. |
sequence_enroll_contacts | Preview, 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.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/sequence-contact-mark-finished |
| MCP tool | sequence_contact_mark_finished on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Free, uses no credits. |
| Permission | Create & edit sequences (sequences.create_edit) |
| Confirmation | Not needed. |
| Pagination | Returns 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.
| Parameter | Type | Required | Description |
|---|---|---|---|
sequence_oid | string | No | Pattern ^[0-9a-fA-F]{24}$. |
saved_person_oids | array of string | Yes | Up to 20000 items. |
sequence_oids | array of string | No | Up to 50 items. |
reason | string (enum) | No | One 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.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/sequence-contact-pause |
| MCP tool | sequence_contact_pause on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Free, uses no credits. |
| Permission | Create & edit sequences (sequences.create_edit) |
| Confirmation | Not needed. |
| Pagination | Returns 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.
| Parameter | Type | Required | Description |
|---|---|---|---|
sequence_oid | string | Yes | MongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$. |
saved_person_oids | array of string | Yes | Up 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.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/sequence-contact-reattribute-mailbox |
| MCP tool | sequence_contact_reattribute_mailbox on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Free, uses no credits. |
| Permission | Create & edit sequences (sequences.create_edit) |
| Confirmation | Not needed. |
| Pagination | Returns 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.
| Parameter | Type | Required | Description |
|---|---|---|---|
sequence_oid | string | Yes | MongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$. |
saved_person_oids | array of string | Yes | Up to 20000 items. |
mailbox_oid | string | Yes | MongoDB 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).
| Endpoint | POST https://api.prospeo.io/api/v2/tools/sequence-contact-remove |
| MCP tool | sequence_contact_remove on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Free, uses no credits. |
| Permission | Create & edit sequences (sequences.create_edit) |
| Confirmation | Not needed. |
| Pagination | Returns 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.
| Parameter | Type | Required | Description |
|---|---|---|---|
sequence_oid | string | Yes | MongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$. |
saved_person_oids | array of string | Yes | Up 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.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/sequence-contact-resume |
| MCP tool | sequence_contact_resume on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Free, uses no credits. |
| Permission | Create & edit sequences (sequences.create_edit) |
| Confirmation | Not needed. |
| Pagination | Returns 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.
| Parameter | Type | Required | Description |
|---|---|---|---|
sequence_oid | string | Yes | MongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$. |
saved_person_oids | array of string | Yes | Up 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.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/sequence-contacts-export |
| MCP tool | sequence_contacts_export on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Free, uses no credits. |
| Permission | sequences.team.read (sequences.team.read) |
| Confirmation | Not needed. |
| Pagination | Returns 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.
| Parameter | Type | Required | Description |
|---|---|---|---|
sequence_oid | string | Yes | MongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$. |
statuses | array of string | No | |
master_status | string | No | |
finished_reasons | array of string | No | |
finished_by | array of string or “automatic” | No | Up to 500 items. |
finished_after | string | No | |
finished_before | string | No | |
stage_ids | array of integer | No | |
steps | array of integer | No | |
mailbox_oids | array of string | No | |
job_titles | array of string | No | |
contact_oids | array of string | No | |
last_contacted_after | string | No | |
last_contacted_before | string | No |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
sequence_contacts_search
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.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/sequence-contacts-search |
| MCP tool | sequence_contacts_search on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | sequences.team.read (sequences.team.read) |
| Confirmation | Not needed. |
| Pagination | Page-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.
| Parameter | Type | Required | Description |
|---|---|---|---|
sequence_oid | string | Yes | The sequence’s id. At most 64 characters. Length 1 to 64. |
statuses | array of string (enum) | No | Restrict 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_status | string (enum) | No | Restrict to the coarse ACTIVE (still moving) or SENT (received at least one email) bucket. One of: ACTIVE, SENT. |
finished_reasons | array of string (enum) | No | Restrict 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_ids | array of integer | No | Restrict to contacts on these CRM stage ids. At most 50. Up to 50 items. |
steps | array of integer | No | Restrict to contacts currently at these 0-based step indexes. At most 15. Up to 15 items. |
mailbox_oids | array of string | No | Restrict to contacts sending from these mailboxes. At most 200 ids. Up to 200 items. |
contact_oids | array of string | No | Restrict to these specific contacts, by saved-person id. At most 200 ids. Up to 200 items. |
last_contacted_after | string | No | Only contacts last contacted at/after this time. |
last_contacted_before | string | No | Only contacts last contacted at/before this time. |
page | integer | No | 1-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.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/sequence-enroll-contacts |
| MCP tool | sequence_enroll_contacts on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Free, uses no credits. |
| Permission | sequences.team.read (sequences.team.read), Create & edit sequences (sequences.create_edit) |
| Confirmation | Recommended: MCP clients should confirm with the user before calling. |
| Pagination | Returns 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.
| Parameter | Type | Required | Description |
|---|---|---|---|
saved_person_oids | array of string | No | Up to 20000 items. |
list_oid | string | No | |
person_oids | array of string | No | Up to 20000 items. |
select_type | string | No | |
filter_config_token | string | No | |
manually_excluded_person_oids | array of string | No | Up to 20000 items. |
cohort | string | No | Default "ALL". |
skip_in_other | boolean | No | Default false. |
find_emails | boolean | No | Default false. |
find_mobiles | boolean | No | Default false. |
enrich_mobiles | boolean | No | Default false. |
sequence_oid | string | No | Pattern ^[0-9a-fA-F]{24}$. |
name | string | No | Length 0 to 200. |
send_from_oids | array of string | No | Up to 200 items. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.