Zapmail
Overview
API Reference
Overview
API Reference
  1. Capabilities
  • Introduction
  • Quickstart
  • Authentication
  • MCP
  • Versioning
  • Errors
  • Webhooks
  • Rate Limits
  • Pagination
  • Changelog
  • Capabilities
    • Mailboxes
    • Pre-Warmed
    • Deliverability
    • Domains
    • Export to Sequencer
    • Zapbox
    • Team Management
    • ZapShield
    • ZapCare
    • AI Insight
    • Deliverability Tests
    • ZapSites
    • Zapwarm
    • ZapPulse
  • Billing
    • Understanding Zapmail billing
    • Wallet
  1. Capabilities

Deliverability Tests

A Deliverability Test sends a test email from each selected mailbox to seed inboxes and records where it lands: inbox, spam, bounce or other tabs. You can pay for a single test per mailbox or subscribe to a monthly plan that grants credits, where one credit runs one test for one mailbox.
Before you start: the one-time test and the plan need an active base plan on the account. Plan credits are account-wide, not per workspace.

Run a test#

1
Choose mailboxes
List Deliverability Test Eligible Mailboxes lists mailboxes that can be tested, grouped by domain. A mailbox is eligible when its domain is ACTIVE, it matches the status filter (default ACTIVE), it has no disable reason, and no test is currently running on it. The call is read-only despite being a POST.
2
Optionally write the email
By default a standard test email is sent. To use your own, send both subject and body (HTML). With enableSpintax set to true, {a/b/c} groups are resolved per mailbox. POST /placement-tests/generate-spintax starts AI generation of spintax variants; it returns 202 with a jobId, and the result is published to the realtime channel spintax_<jobId>. This API has no endpoint to fetch it later, and it does not charge.
3
Start the test
Purchase Deliverability Test with placementType, testName and seedAccounts (google, yahoo, gmail or microsoft365). Select mailboxes with mailboxIds, or with tagIds, contains and status; no selector means every mailbox in the workspace.
4
Read results
List Deliverability Test Orders lists tests, one row per test. A test is IN_PROGRESS while any mailbox is running, FAILED when none succeeded, otherwise SUCCESS. Take cartOrderId from a row and call Get Deliverability Test Report for placement statistics, a breakdown per seed provider and the individual emails. For workspace-wide totals use Get Deliverability Test Overall Report.

One-time or monthly#

placementTypeHow it is paidNotes
ONE_TIMEPer mailbox through the wallet. The test starts after the invoice is paid.Reference price USD 2 per mailbox. Fails with 400 if a selected mailbox already has a running test.
MONTHLYPlan credits, 1 per mailbox. Starts at once and charges nothing.Returns 400 with hasCredits: false if credits are short, and 207 if some mailboxes could not be queued.
This charges your wallet for ONE_TIME only. The key owner is charged: an invoice is settled from wallet credit, and any uncovered amount stays due on the hosted invoice at checkoutUrl.

Plans and credits#

Purchase Deliverability Test Plan subscribes to a monthly plan: starter USD 29 for 30 credits, growth USD 99 for 200, pro USD 199 for 500. Credits are created after the invoice is paid. Every call creates a new subscription.
Get Deliverability Test Available Slots returns the credits left. Monthly plans are consumed before lifetime plans.
GET /placement-tests/subscriptions lists your plan subscriptions, including cancelled ones.
Cancel Deliverability Test Subscription cancels a plan. A monthly plan stops renewing at the end of the current period and its credits stay usable until then; send revertCancellation: true to undo a pending monthly cancellation. A lifetime plan is cancelled immediately and cannot be reverted. Credits already used are not refunded.
This charges your wallet for the plan price now and on each monthly renewal. The first invoice is settled from wallet credit, and any uncovered amount stays due on the hosted invoice.
Related: Deliverability, Mailboxes, Wallet, Webhooks (placement_test.status_changed).
Previous
AI Insight
Next
ZapSites
Built with