Skip to Content

Mailboxes

ToolWhat it does
domain_listList 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_searchRead 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_pausePause sending from one accessible mailbox.
mailbox_resumeResume sending from one accessible paused mailbox.
mailbox_searchFind 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_listList which sequences currently send from one mailbox, with each sequence’s intent and how many contacts it’s sending to from that mailbox.
mailbox_verifyVerify connectivity for selected accessible mailboxes, or all team mailboxes.
mailbox_warmup_enableEnable warm-up with the owner’s paid-through price estimate.
mailbox_warmup_pausePause warm-up for one accessible mailbox.
mailbox_warmup_resumeResume warm-up with the owner’s paid-through price estimate.
mailbox_warmup_statsGet 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.

EndpointPOST https://api.prospeo.io/api/v2/tools/domain-list
MCP tooldomain_list on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
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.

This endpoint takes an empty body: {}.

Response

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

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.

EndpointPOST https://api.prospeo.io/api/v2/tools/mailbox-activity-search
MCP toolmailbox_activity_search on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
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
mailbox_oidstringYesThe mailbox’s public id (1-128 characters). Must belong to the caller’s team. Length 1 to 128.
pageintegerNo1-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.

EndpointPOST https://api.prospeo.io/api/v2/tools/mailbox-pause
MCP toolmailbox_pause on https://mcp.prospeo.io
EffectChanges data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
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
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.

mailbox_resume

Resume sending from one accessible paused mailbox.

Un-pause a mailbox so it resumes sending.

EndpointPOST https://api.prospeo.io/api/v2/tools/mailbox-resume
MCP toolmailbox_resume on https://mcp.prospeo.io
EffectChanges data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
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
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.

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.

EndpointPOST https://api.prospeo.io/api/v2/tools/mailbox-search
MCP toolmailbox_search on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
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
searchstringNoFree text matched against the mailbox’s address (max 200 characters). Length 0 to 200.
statusesarray of string (enum)NoComputed 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.
sourcesarray of string (enum)NoConnection-source values to filter on: PURCHASED, IMPORTED, OAUTH. Empty means no source filter. Up to 3 items. Items one of: PURCHASED, IMPORTED, OAUTH.
providersarray of string (enum)NoProvider values to filter on: GOOGLE, OUTLOOK, SMTP. Empty means no provider filter. Up to 3 items. Items one of: GOOGLE, OUTLOOK, SMTP.
tagstringNoExact tag to filter on (max 80 characters). Length 0 to 80.
connected_fromstringNoOnly mailboxes first connected on or after this ISO-8601 timestamp.
connected_tostringNoOnly mailboxes first connected on or before this ISO-8601 timestamp.
pageintegerNo1-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.

EndpointPOST https://api.prospeo.io/api/v2/tools/mailbox-sequences-list
MCP toolmailbox_sequences_list on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
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
mailbox_oidstringYesThe 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.

EndpointPOST https://api.prospeo.io/api/v2/tools/mailbox-verify
MCP toolmailbox_verify on https://mcp.prospeo.io
EffectChanges data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
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
mailbox_oidsarray of stringNoEmpty = 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.

EndpointPOST https://api.prospeo.io/api/v2/tools/mailbox-warmup-enable
MCP toolmailbox_warmup_enable on https://mcp.prospeo.io
EffectChanges data.
CreditsCan charge credits. At most 100 credits per item. The response’s charge field reports what was charged.
PermissionNo role permission beyond API access.
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
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.

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.

EndpointPOST https://api.prospeo.io/api/v2/tools/mailbox-warmup-pause
MCP toolmailbox_warmup_pause on https://mcp.prospeo.io
EffectChanges data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
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
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.

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.

EndpointPOST https://api.prospeo.io/api/v2/tools/mailbox-warmup-resume
MCP toolmailbox_warmup_resume on https://mcp.prospeo.io
EffectChanges data.
CreditsCan charge credits. At most 100 credits per item. The response’s charge field reports what was charged.
PermissionNo role permission beyond API access.
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
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.

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.

EndpointPOST https://api.prospeo.io/api/v2/tools/mailbox-warmup-stats
MCP toolmailbox_warmup_stats on https://mcp.prospeo.io
EffectReads data.
CreditsFree, uses no credits.
PermissionNo role permission beyond API access.
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
mailbox_oidstringYesThe 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.

Last updated on