Mailboxes
| Tool | What it does |
|---|---|
domain_list | List the team’s purchased or registered sending domains: billing status, yearly price, renewal date, forwarding URL, and how many mailboxes live on each. |
mailbox_activity_search | Read one mailbox’s activity and sending history: paused, resumed, warm-up toggled, owner added or removed, credentials updated, errors raised or cleared, newest first. |
mailbox_pause | Pause sending from one accessible mailbox. |
mailbox_resume | Resume sending from one accessible paused mailbox. |
mailbox_search | Find mailboxes (Email Accounts) by status, connection source, provider, tag, or connected date: connection health, warm-up substatus, daily send capacity, tags, and owners. Search free text against a mailbox’s address. Use to answer which mailboxes are connected, healthy, erroring, paused, or tagged a certain way. |
mailbox_sequences_list | List which sequences currently send from one mailbox, with each sequence’s intent and how many contacts it’s sending to from that mailbox. |
mailbox_verify | Verify connectivity for selected accessible mailboxes, or all team mailboxes. |
mailbox_warmup_enable | Enable warm-up with the owner’s paid-through price estimate. |
mailbox_warmup_pause | Pause warm-up for one accessible mailbox. |
mailbox_warmup_resume | Resume warm-up with the owner’s paid-through price estimate. |
mailbox_warmup_stats | Get one mailbox’s warm-up performance chart: daily sent, reply, and landed-in-spam counts for the last 14 reported days, whether the warm-up provider has reported any activity yet, and how many days warm-up has been active. |
domain_list
List the team’s purchased or registered sending domains: billing status, yearly price, renewal date, forwarding URL, and how many mailboxes live on each.
List the team’s purchased/registered sending domains with billing status, yearly price, renewal date, forwarding URL, and how many mailboxes live on each.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/domain-list |
| MCP tool | domain_list on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| 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.
This endpoint takes an empty body: {}.
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
mailbox_activity_search
Read one mailbox’s activity and sending history: paused, resumed, warm-up toggled, owner added or removed, credentials updated, errors raised or cleared, newest first.
Read the append-only management/health audit trail for one specific mailbox (paused/resumed, warm-up toggled, owner added/removed, errors raised/cleared, etc.), newest activity paginated.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/mailbox-activity-search |
| MCP tool | mailbox_activity_search on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| 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 |
|---|---|---|---|
mailbox_oid | string | Yes | The mailbox’s public id (1-128 characters). Must belong to the caller’s team. Length 1 to 128. |
page | integer | No | 1-based page number, minimum 1. The endpoint fixes 25 rows per page and exposes no other filter. From 1 to any. Default 1. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
mailbox_pause
Pause sending from one accessible mailbox.
Pause a mailbox so it stops sending; billing and warm-up are left untouched.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/mailbox-pause |
| MCP tool | mailbox_pause on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| 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 |
|---|---|---|---|
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.
mailbox_resume
Resume sending from one accessible paused mailbox.
Un-pause a mailbox so it resumes sending.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/mailbox-resume |
| MCP tool | mailbox_resume on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| 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 |
|---|---|---|---|
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.
mailbox_search
Find mailboxes (Email Accounts) by status, connection source, provider, tag, or connected date: connection health, warm-up substatus, daily send capacity, tags, and owners. Search free text against a mailbox’s address. Use to answer which mailboxes are connected, healthy, erroring, paused, or tagged a certain way.
Search the team’s mailboxes with the full filter surface the Email Accounts table offers: free text, computed status, connection source, provider, tag, and connected-date range.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/mailbox-search |
| MCP tool | mailbox_search on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| 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 | Free text matched against the mailbox’s address (max 200 characters). Length 0 to 200. |
statuses | array of string (enum) | No | Computed mailbox status values to filter on: NOT_ACTIVE, ACTIVE, HAS_ERRORS, PAUSED. Empty means no status filter. Leave it empty to answer which mailboxes are connected: a status filter counts only that status, so HAS_ERRORS finding none says nothing about the other mailboxes. Up to 4 items. Items one of: NOT_ACTIVE, ACTIVE, HAS_ERRORS, PAUSED. |
sources | array of string (enum) | No | Connection-source values to filter on: PURCHASED, IMPORTED, OAUTH. Empty means no source filter. Up to 3 items. Items one of: PURCHASED, IMPORTED, OAUTH. |
providers | array of string (enum) | No | Provider values to filter on: GOOGLE, OUTLOOK, SMTP. Empty means no provider filter. Up to 3 items. Items one of: GOOGLE, OUTLOOK, SMTP. |
tag | string | No | Exact tag to filter on (max 80 characters). Length 0 to 80. |
connected_from | string | No | Only mailboxes first connected on or after this ISO-8601 timestamp. |
connected_to | string | No | Only mailboxes first connected on or before this ISO-8601 timestamp. |
page | integer | No | 1-based page number, minimum 1. The endpoint fixes 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.
mailbox_sequences_list
List which sequences currently send from one mailbox, with each sequence’s intent and how many contacts it’s sending to from that mailbox.
List which sequences currently send from a given mailbox, with each sequence’s intent and how many contacts it’s sending to from that mailbox.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/mailbox-sequences-list |
| MCP tool | mailbox_sequences_list on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| 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 |
|---|---|---|---|
mailbox_oid | string | Yes | The mailbox’s public id (1-128 characters). Must belong to the caller’s team. Length 1 to 128. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
mailbox_verify
Verify connectivity for selected accessible mailboxes, or all team mailboxes.
Run an on-demand connectivity check (SMTP/IMAP login or OAuth token refresh) against a selected batch of mailboxes, or every team mailbox if none are named, and report which passed. Never sends an email; free, and updates each mailbox’s health status immediately.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/mailbox-verify |
| MCP tool | mailbox_verify on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| 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 |
|---|---|---|---|
mailbox_oids | array of string | No | Empty = verify every team mailbox |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.
mailbox_warmup_enable
Enable warm-up with the owner’s paid-through price estimate.
Turn on warm-up for one mailbox (Warmup Inbox provider). First activation bills a full warm-up month immediately; re-enabling after a previously-paid month has fully elapsed bills a fresh month and resets the billing anniversary — re-enabling inside an already-paid month is free. Card must show the full possible charge before running.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/mailbox-warmup-enable |
| MCP tool | mailbox_warmup_enable on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Can charge credits. At most 100 credits per item. The response’s charge field reports what was charged. |
| Permission | No role permission beyond API access. |
| 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 |
|---|---|---|---|
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.
mailbox_warmup_pause
Pause warm-up for one accessible mailbox.
Pause a mailbox’s warm-up only (independent of pausing the mailbox itself); always free.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/mailbox-warmup-pause |
| MCP tool | mailbox_warmup_pause on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| 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 |
|---|---|---|---|
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.
mailbox_warmup_resume
Resume warm-up with the owner’s paid-through price estimate.
Resume a paused warm-up. Free and instant if the previously-paid warm-up month hasn’t ended yet; if it has, resuming re-bills one warm-up month and starts a new billing anniversary. Card must show the full possible charge before running.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/mailbox-warmup-resume |
| MCP tool | mailbox_warmup_resume on https://mcp.prospeo.io |
| Effect | Changes data. |
| Credits | Can charge credits. At most 100 credits per item. The response’s charge field reports what was charged. |
| Permission | No role permission beyond API access. |
| 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 |
|---|---|---|---|
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.
mailbox_warmup_stats
Get one mailbox’s warm-up performance chart: daily sent, reply, and landed-in-spam counts for the last 14 reported days, whether the warm-up provider has reported any activity yet, and how many days warm-up has been active.
Get a mailbox’s warm-up chart data: daily sent/replies/landed-in-spam series, provider-pending flag, and days active.
| Endpoint | POST https://api.prospeo.io/api/v2/tools/mailbox-warmup-stats |
| MCP tool | mailbox_warmup_stats on https://mcp.prospeo.io |
| Effect | Reads data. |
| Credits | Free, uses no credits. |
| Permission | No role permission beyond API access. |
| 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 |
|---|---|---|---|
mailbox_oid | string | Yes | The mailbox’s public id (1-128 characters). Must belong to the caller’s team. Length 1 to 128. |
Response
{"ok": true, "summary": "...", "payload": {...}} on success. Errors return {"ok": false, "code", "message", "retryable"}; see error codes.