Skip to Content
Tools referenceDeliverability

Deliverability

ToolWhat it does
deliverability_create_managedRun a managed deliverability test through connected mailboxes and owner billing.
deliverability_getFetch one deliverability test’s full result: inbox placement percent, spam verdict, content checks, reputation and blocklist standing, which email providers landed the test in spam, a recommendation, and - only on a not-enough-credits failure - the team’s current credit balance. Any teammate can look up any team test by id, not just their own.
deliverability_historyGet the placement-percent trend for one deliverability test’s lineage - its re-run chain, oldest to newest - for a ‘compare to last time’ chart.
deliverability_listPage through the team’s deliverability test history: mode, status, which mailbox(es) each test ran on, inbox placement percent, who started it, and any repeat schedule, newest first. Use to answer ‘what deliverability tests have we run’ or to find a test id to inspect in detail.
deliverability_rerunRerun all or failed mailboxes from an accessible deliverability test.

deliverability_create_managed

Run a managed deliverability test through connected mailboxes and owner billing.

Launch a new Managed deliverability test that sends inbox-placement, spam, and sender-reputation probes through the user’s own connected mailbox(es), using either a rendered sequence-step copy or plain independent text. Charges 20 credits per connected mailbox at launch and requires a paid plan; use when the user wants to check where their sends will land before (or instead of) a live sequence send.

EndpointPOST https://api.prospeo.io/api/v2/tools/deliverability-create-managed
MCP tooldeliverability_create_managed on https://mcp.prospeo.io
EffectChanges data.
CreditsCan charge credits. At most 20 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_oidsarray of stringNo
copy_sourceobjectYes§0.7 — sequence step (rendered with a real random contact) OR plain text, never both.
schedule_cadence”WEEKLY”No

Response

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

deliverability_get

Fetch one deliverability test’s full result: inbox placement percent, spam verdict, content checks, reputation and blocklist standing, which email providers landed the test in spam, a recommendation, and - only on a not-enough-credits failure - the team’s current credit balance. Any teammate can look up any team test by id, not just their own.

Fetch one deliverability test’s full result — placement %, spam verdict, content checks, reputation standing/domain breakdown, recommendation, and (only on a not-enough-credits failure) the team’s current credit balance. Team-wide visibility: any teammate can look up any team test by id, not just their own.

EndpointPOST https://api.prospeo.io/api/v2/tools/deliverability-get
MCP tooldeliverability_get 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
test_oidstringYesThe deliverability test’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.

deliverability_history

Get the placement-percent trend for one deliverability test’s lineage - its re-run chain, oldest to newest - for a ‘compare to last time’ chart.

Get the placement-percent trend for one test’s lineage — walking its re-run chain, then extending backward to other comparable tests on the same mailbox set — oldest to newest, for a ‘vs last time’ comparison chart. Team-scoped, ungated like deliverability_get.

EndpointPOST https://api.prospeo.io/api/v2/tools/deliverability-history
MCP tooldeliverability_history 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
test_oidstringYesThe deliverability test’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.

deliverability_list

Page through the team’s deliverability test history: mode, status, which mailbox(es) each test ran on, inbox placement percent, who started it, and any repeat schedule, newest first. Use to answer ‘what deliverability tests have we run’ or to find a test id to inspect in detail.

Page through the team’s deliverability test history (mode, status, mailbox(es), placement %, who started it, schedule cadence), newest first. Use to answer ‘what deliverability tests have we run’ or to locate a test id to inspect with deliverability_get.

EndpointPOST https://api.prospeo.io/api/v2/tools/deliverability-list
MCP tooldeliverability_list 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
pageintegerNo1-based page number, minimum 1. The endpoint fixes 25 rows per page and exposes no status/mode/date filter. From 1 to any. Default 1.

Response

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

deliverability_rerun

Rerun all or failed mailboxes from an accessible deliverability test.

Re-run a Partial or Failed deliverability test as a brand-new, separately-tracked test — either the whole original mailbox set or (scope=‘FAILED’) only the mailboxes that failed mid-test — never mutating the original record. A Managed-mode original bills 20 credits per re-run mailbox immediately and requires a paid plan; an External-mode original just re-issues test addresses.

EndpointPOST https://api.prospeo.io/api/v2/tools/deliverability-rerun
MCP tooldeliverability_rerun on https://mcp.prospeo.io
EffectChanges data.
CreditsCan charge credits. At most 20 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
test_oidstringYesMongoDB ObjectId Pattern ^[0-9a-fA-F]{24}$.
scopestring (enum)NoOne of: ALL, FAILED. Default "ALL".
sending_emailstringNo
test_namestringNo

Response

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

Last updated on