Test every mailbox or pick a subset.
Pass {"mailboxes": [3, 7, 23]} to limit a test to specific providers. Leave the body empty to seed across every enabled mailbox. Mailbox IDs come from GET /inbox-placement/mailboxes.
Create a test over REST, send your email to each returned mailbox with the test id inside, and read back the folder and tab each one put it in as JSON.
Pass {"mailboxes": [3, 7, 23]} to limit a test to specific providers. Leave the body empty to seed across every enabled mailbox. Mailbox IDs come from GET /inbox-placement/mailboxes.
The results[] array carries one entry per mailbox with its delivery status, the tab the email landed in, the sender and sender_ip the receiver saw, and a public-blocklist count in blacklists.
The /scheduled-tests endpoints run placement tests on a schedule you set, with alert settings and results per run. Hook the JSON into Datadog, PagerDuty, Slack, or whatever already pages your team. See automatic testing.
GET /inbox-placement?page=N&per_page=15 returns the tests you created through the API, with id, status, timestamps and the hosted report_url. Read any of them back by id to follow per-mailbox drift week over week without rebuilding storage on your side.
A per-mailbox folder verdict, sender forensics, and blocklist exposure: the data your monitoring stack needs to act.
Each results[].tab reports where the email landed in that mailbox: Inbox, Spam, or a Gmail tab such as Promotions, Social, Updates or Forums. It stays null until the message arrives. Aggregate scores hide where reputation damage is actually happening; this answers the question directly.
The status field reports delivery: success once the mailbox has the message, pending while we wait for it, and failed if it never arrived.
Every result entry carries sender, sender_ip, and blacklists (the count of public blocklists the engine detected on the sending IP at delivery time). You see what the receiver saw, not just what your own logs show.
Pipe these straight into your reputation dashboard or use them to throttle a problematic IP before it impacts the next campaign.
GET /ext/v2/inbox-placement/mailboxes returns every enabled mailbox with id, name, and the live address. Pick the IDs that match your audience and pass them to the create endpoint.
No need to seed every provider for a B2B SaaS sending mostly to corporate Outlook. Scope tightly and save your quota.
Inbox placement is asynchronous: list mailboxes, create a test, send your email to each returned address, then read the per-provider verdicts.
GET /ext/v2/inbox-placement/mailboxes returns the full set of enabled mailboxes with stable IDs. Useful once at setup, then on a refresh schedule as providers come online.
POST /ext/v2/inbox-placement with an optional mailboxes filter. The 201 response returns the test id and the list of mailbox addresses you need to deliver to.
Deliver from your platform to every returned address. Include the test id in the subject or body so our engine can match the message to the test.
GET /ext/v2/inbox-placement/{id} returns results[] with each mailbox's status, tab, sender_ip and blacklists count. Poll until the test's own status leaves pending: it ends as success or failed.
20 endpoints, on the same token as the rest of the API. The OpenAPI document has every parameter and response code.
OpenAPI document/inbox-placement/inbox-placement/inbox-placement/mailboxes/inbox-placement/{id}/scheduled-test-senders/scheduled-test-senders/scheduled-test-senders/{id}/scheduled-test-senders/{id}/scheduled-test-senders/{id}/scheduled-test-senders/{id}/test-connection/scheduled-tests/scheduled-tests/scheduled-tests/{id}/scheduled-tests/{id}/scheduled-tests/{id}/scheduled-tests/{id}/scheduled-tests/{id}/dispatch-now/scheduled-tests/{id}/email/scheduled-tests/{id}/runs/scheduled-tests/{id}/runs/{runId}Mailbox mechanics, polling, rate limits, and what each provider verdict means.
POST /ext/v2/inbox-placement returns a test id and a list of mailbox addresses. Your platform delivers the real email to each one, with the test id in the subject or body so we can match it. Then GET /ext/v2/inbox-placement/{id} returns per-mailbox verdicts, and the test's status ends as success or failed.GET /ext/v2/inbox-placement/mailboxes.blacklists field on each result is the number of public blocklists our engine detected the sending IP on at delivery time. Zero is the expected state; anything higher is a reputation problem to chase down through your sender / ESP.GET /ext/v2/inbox-placement?page=1&per_page=15 returns a paginated list of tests created via the API, with id, status, timestamps, and the report_url for each.GET /inbox-placement/{id} with exponential back-off until status is success or failed.POST /ext/v2/client-previews with email_source set to inbox-placement and the test id as source_id renders the message you sent in real clients and devices. The test result then carries its client_preview_id. See the email preview API.API access is included with the Custom plan, bought online from a $5 monthly minimum. Build it into your own product and resell it under your own brand.