Sequences
| Tool | What it does |
|---|---|
draft_regenerate | Regenerate one unsent unlocked sequence draft. |
reply_agent_activity | List what the AI Reply Agent has done lately, newest first, as short lines: drafted a reply, auto-sent a saved reply, added a contact to a follow-up, created a task, out of credits, categorization failed, auto-sent an AI reply. 25 per page; pass the returned cursor for older activity. |
reply_agent_enable | Add one reply rule (WHEN a reply matches, THEN one to four actions) at the bottom of each selected sequence’s rule list, 1 to 20 sequences per call. Needs approval. Nothing auto-sends unless the user explicitly asked for it: leave auto_send off, and set it true only on the action the user asked to send automatically. Find sequence ids with the Reply Agent overview. |
reply_agent_overview | Show the AI Reply Agent page: the last 30 days of drafts created, tasks created and auto-sent replies, the drafts pending review now, how many sequences it is active on, and a per-sequence table with its status (active, needs setup or off), live rules, fires, pending drafts, last fire and whether the user can edit it. Filter by name or status; 10 sequences per page. |
reply_rule_list | List a sequence’s reply-rule automations — the WHEN a reply matches, THEN do X rules, in evaluation order. |
sequence_activate | Activate one start-ready sequence after approval. |
sequence_activity_search | Search one sequence’s activity feed — opens, clicks, replies, bounces and unsubscribes over a date range. |
sequence_analytics_get | Get one sequence’s own performance analytics for a date range — reply rate, positive replies, bounces, deals, and which step is underperforming. |
sequence_archive | Archive one sequence after approval, optionally finishing remaining contacts. |
sequence_create_draft | Save a reviewed AI-builder result as a sequence draft. |
sequence_create_from_list | Create a draft sequence with one empty email step and enrol every contact on one accessible list into it, after approval. It cannot add steps; tell the user to add wait or call steps in the sequence builder. |
sequence_drafts_list | List a sequence’s upcoming and sent email drafts — subject/body preview, why an email hasn’t sent yet, filter by contact, step or mailbox. |
sequence_get | Get one sequence’s steps, settings, tags and current status by sequence id. |
sequence_pause | Pause one running sequence. |
sequence_portfolio_analytics | Get performance analytics across all of the team’s sequences — reply rate, bounces, deals, and a sortable per-sequence table. |
sequence_resume | Resume one paused sequence after approval. |
sequence_schedule_preview | Preview when a scheduled email or task will actually go out, in the contact’s own timezone. |
sequence_search | Find or browse the team’s sequences by name, tag, status or creator, with live facet counts. |
sequence_send_test | Send the frozen rendered sequence preview to up to five approved recipients. |
sequence_template_list | List Prospeo’s full-sequence starter templates, searchable by name and filterable by channel type. |
template_email_list | List reusable single-email templates — your own, shared by teammates, or Prospeo’s built-in library. |
draft_regenerate
Regenerate one unsent unlocked sequence draft.
Regenerate a sequence step’s draft subject/body from the current template and freshly-resolved contact/mailbox variables, discarding whatever was rendered before. Free, deterministic re-render — refuses if the user has manually edited the draft (locked) or it has already left the editable state.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/draft-regenerate |
| MCP tool | draft_regenerate 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 |
|---|---|---|---|
email_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.
reply_agent_activity
List what the AI Reply Agent has done lately, newest first, as short lines: drafted a reply, auto-sent a saved reply, added a contact to a follow-up, created a task, out of credits, categorization failed, auto-sent an AI reply. 25 per page; pass the returned cursor for older activity.
List what the AI Reply Agent has done lately, newest first, as short plain-text lines: drafted a reply and waiting for review, auto-sent a saved reply, added a contact to a follow-up sequence, created a task, ran out of credits so no draft was made, a reply that could not be categorized, auto-sent an AI reply. Contacts appear as first name and last initial. Use to answer what the Reply Agent has been doing.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/reply-agent-activity |
| MCP tool | reply_agent_activity on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | sequences.team.read (sequences.team.read) |
| Confirmation | Not needed. |
| Pagination | Cursor-based: cursor. |
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 |
|---|---|---|---|
cursor | string | No | The cursor returned by the previous call, to see older activity. Omit it for the newest 25 items. Length 1 to 512. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
reply_agent_enable
Add one reply rule (WHEN a reply matches, THEN one to four actions) at the bottom of each selected sequence’s rule list, 1 to 20 sequences per call. Needs approval. Nothing auto-sends unless the user explicitly asked for it: leave auto_send off, and set it true only on the action the user asked to send automatically. Find sequence ids with the Reply Agent overview.
Add one reply rule (WHEN a reply matches, THEN one to four actions) at the bottom of each selected sequence’s rule list, so the AI Reply Agent starts handling replies there. Always asks for approval first; the card states the rule in words, how many sequences get it, the review rules and whether anything sends automatically. Nothing auto-sends unless the user explicitly asked for it.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/reply-agent-enable |
| MCP tool | reply_agent_enable on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Free, uses no credits. |
| Permission | 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 |
|---|---|---|---|
rule | object | Yes | The rule to add: one trigger and one to four actions. |
sequence_oids | array of string | Yes | The sequences to add the rule to, 1 to 20, each listed once, from the Reply Agent overview. Up to 20 items. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
reply_agent_overview
Show the AI Reply Agent page: the last 30 days of drafts created, tasks created and auto-sent replies, the drafts pending review now, how many sequences it is active on, and a per-sequence table with its status (active, needs setup or off), live rules, fires, pending drafts, last fire and whether the user can edit it. Filter by name or status; 10 sequences per page.
Show the AI Reply Agent page: the last 30 days of drafts created, tasks created and auto-sent replies, the drafts pending review now, how many sequences the agent is active on, and a per-sequence table with its status (active, needs setup or off), live rules, fires, pending drafts, last fire and whether the user can edit its rules. Use to see where the Reply Agent is turned on and how it is doing, or to find sequences to turn it on for.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/reply-agent-overview |
| MCP tool | reply_agent_overview 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 |
|---|---|---|---|
page | integer | No | Page number, starting at 1, 10 sequences per page. From 1 to 1000. Default 1. |
search | string | No | Part of a sequence’s name, up to 200 characters. Length 1 to 200. |
agent_statuses | array of string (enum) | No | Only sequences whose Reply Agent status is one of these: active (at least one live rule), needs_setup (a rule waiting on a missing saved reply or follow-up sequence) or off (no rule). Leave empty for every sequence. Up to 3 items. Items one of: active, needs_setup, off. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
reply_rule_list
List a sequence’s reply-rule automations — the WHEN a reply matches, THEN do X rules, in evaluation order.
List one sequence’s “when a reply matches, then do X” automation rules in evaluation order, given its sequence_oid. Use to show or explain what happens automatically when a sequence’s contacts reply.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/reply-rule-list |
| MCP tool | reply_rule_list on https://mcp.prospeo.io |
| Effect | Reads 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 | The sequence’s id. At most 64 characters. Length 1 to 64. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
sequence_activate
Activate one start-ready sequence after approval.
Turn a sequence ON: runs start checks, then begins every not-yet-started contact, which sends real emails to real prospects starting immediately.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/sequence-activate |
| MCP tool | sequence_activate on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Free, uses no credits. |
| Permission | 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 |
|---|---|---|---|
sequence_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_activity_search
Search one sequence’s activity feed — opens, clicks, replies, bounces and unsubscribes over a date range.
Search a sequence’s activity feed (opens, clicks, replies, bounces, unsubscribes) with date-range, mailbox and step filters, cursor-paginated. Use to answer “who clicked/replied/bounced” style questions for one sequence.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/sequence-activity-search |
| MCP tool | sequence_activity_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 | Cursor-based: cursor, limit. |
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. |
cursor | string | No | Continuation cursor from a previous page’s next_cursor. Length 0 to 64. |
limit | integer | No | Max events to return. At most 200. From 1 to 200. Default 50. |
type_filter | array of string | No | Restrict to these event types, e.g. EMAIL_SENT, EMAIL_REPLY_RECEIVED, EMAIL_BOUNCED_HARD. Up to 30 items. |
range_preset | string (enum) | No | Date-range preset: TODAY, 7D, 14D, 30D, 90D, ALL_TIME or CUSTOM. One of: TODAY, 7D, 14D, 30D, 90D, ALL_TIME, CUSTOM. Default "30D". |
custom_start | string | No | Range start. Required (with custom_end) when range_preset is CUSTOM. |
custom_end | string | No | Range end. Required (with custom_start) when range_preset is CUSTOM. |
mailbox_oids | array of string | No | Restrict to these sending mailboxes. At most 200 ids. Up to 200 items. |
step_indexes | array of integer | No | Restrict to these 0-based step indexes. At most 15. Up to 15 items. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
sequence_analytics_get
Get one sequence’s own performance analytics for a date range — reply rate, positive replies, bounces, deals, and which step is underperforming.
Get one sequence’s Analytics tab: KPI cards (with prior-period deltas), the sending and categorization charts, and per-step stats for a date range.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/sequence-analytics-get |
| MCP tool | sequence_analytics_get on https://mcp.prospeo.io |
| Effect | Reads 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 | The sequence’s id. At most 64 characters. Length 1 to 64. |
range_preset | string (enum) | No | Date-range preset: TODAY, 7D, 14D, 30D, 90D, ALL_TIME or CUSTOM. One of: TODAY, 7D, 14D, 30D, 90D, ALL_TIME, CUSTOM. Default "30D". |
custom_start | string | No | Range start. Required (with custom_end) when range_preset is CUSTOM. |
custom_end | string | No | Range end. Required (with custom_start) when range_preset is CUSTOM. |
mailbox_oids | array of string | No | Restrict to these sending mailboxes. At most 200 ids. Up to 200 items. |
step_indexes | array of integer | No | Restrict to these 0-based step indexes. At most 15. Up to 15 items. |
granularity | string (enum) | No | Override the sending chart’s bucket size: day, week or month. Omit for automatic sizing. One of: day, week, month. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
sequence_archive
Archive one sequence after approval, optionally finishing remaining contacts.
Archive a sequence the user names explicitly (it must be paused/off first). Never suggest archiving proactively; warn the user there is currently no way to unarchive it through the API.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/sequence-archive |
| MCP tool | sequence_archive on https://mcp.prospeo.io |
| Effect | Deletes or removes data. |
| Credits | Free, uses no credits. |
| Permission | 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 |
|---|---|---|---|
sequence_oid | string | Yes | MongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$. |
mark_remaining_finished | boolean | No | Default false. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
sequence_create_draft
Save a reviewed AI-builder result as a sequence draft.
Create a DRAFT (never-active) AI-authored 3-email sequence from a product/audience/brief spec. Generates the draft first (stateless), then persists it as an OFF sequence with its own enrollment list and Opener column. On success, navigate the user to the new draft. It always makes exactly three email steps (Day 1, 4, 7); it cannot create wait or call steps, so say so when the user asks for those.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/sequence-create-draft |
| MCP tool | sequence_create_draft 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 |
|---|---|---|---|
name | string | No | |
product_id | string | No | Pattern ^[0-9a-fA-F]{24}$. |
audience_id | string | No | Pattern ^[0-9a-fA-F]{24}$. |
parent_sequence_oid | string | No | Pattern ^[0-9a-fA-F]{24}$. |
emails | array of object | Yes | |
opener_fallback_line | string | Yes |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
sequence_create_from_list
Create a draft sequence with one empty email step and enrol every contact on one accessible list into it, after approval. It cannot add steps; tell the user to add wait or call steps in the sequence builder.
Build a new sequence from an existing list: creates the sequence and ENROLLS every list member into it as a live-feed source (copy everything, free), so later additions to the list are enrolled too. Requires approval; the card names the contact count. The sequence has one empty email step and stays switched off. This tool cannot add wait or call steps; those are added in the sequence builder. Opens the Contacts tab, not the step editor.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/sequence-create-from-list |
| MCP tool | sequence_create_from_list on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Free, uses no credits. |
| Permission | 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 |
|---|---|---|---|
list_oid | string | Yes | |
name | string | No |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
sequence_drafts_list
List a sequence’s upcoming and sent email drafts — subject/body preview, why an email hasn’t sent yet, filter by contact, step or mailbox.
List a sequence’s upcoming/sent email drafts tab, with subject/body rendered, why-not-sent reasons, and per-mailbox/contact filters. No free-text search (drafts are unindexed).
| Endpoint | POST https://api.prospeo.io/api/v2/tools/sequence-drafts-list |
| MCP tool | sequence_drafts_list 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. |
saved_person_oid | string | No | Restrict to one contact’s draft(s), by saved-person id. Length 0 to 64. |
step_index | integer | No | Restrict to one 0-based step index. At most 14. From 0 to 14. |
mailbox_oids | array of string | No | Restrict to drafts sending from these mailboxes. At most 200 ids. Up to 200 items. |
reason_not_sent | string (enum) | No | Restrict to drafts currently held for this one reason. One of: MISSING_DATA, MAILBOX_ISSUE, LIMIT_REACHED, OUTSIDE_SENDING_WINDOW, CONTACT_NOT_SENDABLE, AI_OR_CREDITS_ISSUE, PROVIDER_SEND_ERROR, MANUAL_EMAIL_STATE, PAUSED, CONTACT_PAUSED, TEAM_SUSPENDED, OUT_OF_OFFICE. |
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_get
Get one sequence’s steps, settings, tags and current status by sequence id.
Fetch one sequence’s full detail: steps, settings overrides, status tag, visibility, tags, and how many contacts are enrolled. Use to answer questions about a specific sequence’s structure and current state.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/sequence-get |
| MCP tool | sequence_get on https://mcp.prospeo.io |
| Effect | Reads 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 | The sequence’s id. At most 64 characters. Length 1 to 64. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
sequence_pause
Pause one running sequence.
Pause a running sequence: freezes every contact’s send timer manually, without altering any contact’s status. Fully reversible via sequence_resume.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/sequence-pause |
| MCP tool | sequence_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}$. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
sequence_portfolio_analytics
Get performance analytics across all of the team’s sequences — reply rate, bounces, deals, and a sortable per-sequence table.
Roll up Analytics across every sequence the caller can see (“performance across all client sequences”): KPI cards, a trend chart, and a sortable per-sequence table, filterable by owner/tags/status/mailbox/date range.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/sequence-portfolio-analytics |
| MCP tool | sequence_portfolio_analytics 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 |
|---|---|---|---|
range_preset | string (enum) | No | Date-range preset: TODAY, 7D, 14D, 30D, 90D, ALL_TIME or CUSTOM. One of: TODAY, 7D, 14D, 30D, 90D, ALL_TIME, CUSTOM. Default "30D". |
custom_start | string | No | Range start. Required (with custom_end) when range_preset is CUSTOM. |
custom_end | string | No | Range end. Required (with custom_start) when range_preset is CUSTOM. |
owner_user_oid | string | No | Restrict to sequences owned by this team member. Omit for everyone. Length 0 to 64. |
tag_oids | array of string | No | Restrict to sequences carrying any of these tags. At most 50 ids. Up to 50 items. |
statuses | array of string (enum) | No | Restrict to these sequence statuses: DRAFT, RUNNING, PAUSED_MANUAL, PAUSED_BOUNCE, PAUSED_DELIVERY, ARCHIVED. Up to 6 items. Items one of: DRAFT, RUNNING, PAUSED_MANUAL, PAUSED_BOUNCE, PAUSED_DELIVERY, ARCHIVED. |
mailbox_oids | array of string | No | Restrict to these sending mailboxes. At most 200 ids. Up to 200 items. |
search | string | No | Sequence name substring search. Length 0 to 200. |
sort_by | string (enum) | No | Table sort column. One of: name, status, reached, sent, reply_rate, positive_reply_rate, bounce_rate, deals_amount, owner. Default "reached". |
sort_dir | string (enum) | No | Table sort direction. One of: asc, desc. Default "desc". |
page | integer | No | 1-based page number for the per-sequence table. 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_resume
Resume one paused sequence after approval.
Resume a paused sequence: re-runs start checks, then unfreezes every contact and immediately runs any advance that was queued during the pause — which can send a real email to a real prospect right away, not just resume the schedule silently.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/sequence-resume |
| MCP tool | sequence_resume on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Free, uses no credits. |
| Permission | 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 |
|---|---|---|---|
sequence_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_schedule_preview
Preview when a scheduled email or task will actually go out, in the contact’s own timezone.
Resolve a schedule option (e.g. “in 2 business days”) to a concrete send time and human-readable copy, anchored to the target contact’s timezone. Pure computation — writes nothing. Use to answer “when will this go out” questions.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/sequence-schedule-preview |
| MCP tool | sequence_schedule_preview on https://mcp.prospeo.io |
| Effect | Reads 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 |
|---|---|---|---|
schedule | object | Yes | Mirrors the shared schedule picker’s own wire shape (ScheduleSchema, api/v2/sequences/schemas.py). |
email_oid | string | No | Resolve the contact’s timezone from this draft email. At most one of email_oid/task_oid should be set. Length 0 to 64. |
task_oid | string | No | Resolve the contact’s timezone from this task. At most one of email_oid/task_oid should be set. Length 0 to 64. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
sequence_search
Find or browse the team’s sequences by name, tag, status or creator, with live facet counts.
Find sequences by name, tags, status, or owner. Same underlying operation as sequence_list — this is the typed-filter/search framing the §5f search-not-list law calls for.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/sequence-search |
| MCP tool | sequence_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 |
|---|---|---|---|
search | string | No | Sequence name substring search. Length 0 to 200. |
status_groups | array of string (enum) | No | Restrict to these display status groups: ACTIVE, NOT_STARTED, PAUSED, FINISHED, ARCHIVED. Up to 5 items. Items one of: ACTIVE, NOT_STARTED, PAUSED, FINISHED, ARCHIVED. |
created_by_user_oids | array of string | No | Restrict to sequences created by these team members, by user id. At most 50 ids. Up to 50 items. |
tag_oids | array of string | No | Restrict to sequences carrying any of these tags, by tag id. At most 50 ids. Up to 50 items. |
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_send_test
Send the frozen rendered sequence preview to up to five approved recipients.
Send a real test email for one sequence step/variant through a chosen connected mailbox, bypassing the sequence’s normal queue/caps/analytics. The recipient list is caller-supplied, not restricted to the user’s own address — treat every call as a genuine send to whatever addresses are given.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/sequence-send-test |
| MCP tool | sequence_send_test on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Free, uses no credits. |
| Permission | sequences.team.read (sequences.team.read) |
| 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 |
|---|---|---|---|
sequence_oid | string | Yes | MongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$. |
step_index | integer | Yes | From 0 to any. |
letter | string | No | |
mailbox_oid | string | Yes | MongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$. |
saved_person_oid | string | No | Pattern ^[0-9a-fA-F]{24}$. |
to_emails | array of string | Yes | Up to 5 items. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
sequence_template_list
List Prospeo’s full-sequence starter templates, searchable by name and filterable by channel type.
List full-sequence starter templates (search + type filter: ALL/EMAIL_ONLY/MULTI_CHANNEL/PHONE_FIRST).
| Endpoint | POST https://api.prospeo.io/api/v2/tools/sequence-template-list |
| MCP tool | sequence_template_list on https://mcp.prospeo.io |
| Effect | Reads 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 |
|---|---|---|---|
search | string | No | Optional name/description/step-text search. At most 200 characters. Length 0 to 200. |
type_filter | string (enum) | No | Optional channel-type filter: ALL, EMAIL_ONLY, MULTI_CHANNEL, PHONE_FIRST or SOCIAL_TOUCH. Omit for every type. One of: ALL, EMAIL_ONLY, MULTI_CHANNEL, PHONE_FIRST, SOCIAL_TOUCH. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
template_email_list
List reusable single-email templates — your own, shared by teammates, or Prospeo’s built-in library.
List single-email templates by scope — the user’s own, teammates’ shared templates, or built-in system templates — with an optional name search.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/template-email-list |
| MCP tool | template_email_list on https://mcp.prospeo.io |
| Effect | Reads 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 |
|---|---|---|---|
scope | string (enum) | No | MY (the caller’s own), SHARED (teammates’) or SYSTEM (built-in) templates. One of: MY, SHARED, SYSTEM. Default "MY". |
search | string | No | Optional name substring search. Length 0 to 200. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.