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

AI Insight

AI Insight analyses the last 15 days of a mailbox's data and returns an AI assessment, display metrics, improvement suggestions and a recommended sending ramp. You can pay per analysis or subscribe to a plan that grants credits, where one credit analyses one mailbox.
Before you start: AI Insight plans and one-time purchases need an active base plan on the account. A mailbox is eligible when it is ACTIVE, has no disable reason, has a stored refresh token and sits on an ACTIVE domain.

Run an analysis#

1
Choose mailboxes
List AI Insight Eligible Mailboxes lists eligible mailboxes grouped by domain. Select with mailboxIds, tagIds, contains or filters. With no selector, every eligible mailbox in the workspace is returned.
2
Check the cost
POST /ai-insight/calculate-pricing counts the credits needed and, for the monthly cycle, whether you have enough. It charges nothing. Get AI Insight Credits shows your balance, split into monthly and lifetime subscriptions.
3
Generate
Generate AI Insight Analysis starts one analysis job per mailbox. With an active plan, one credit per mailbox is deducted. Without a plan, nothing is queued: the call creates a one-time invoice and returns a payment link in checkoutUrl. If the plan has fewer credits than mailboxes the call fails and no credits are deducted.
4
Poll
POST /ai-insight/mailbox-analysis lists analyses, newest first. Poll until status is SUCCESS or FAILED. Fetch one with GET /ai-insight/mailbox-analysis/{id}. The result fields are null while the analysis is IN_PROGRESS or when it FAILED.
This charges your wallet on the no-plan path: the account owner is invoiced for one one-time analysis per selected mailbox, and the invoice is paid from wallet balance when it covers the cost, otherwise checkoutUrl is the link for the remainder. With a plan, credits are consumed instead of money.

Buy credits or one-time analyses#

Purchase AI Insight Plan buys a plan (starter, growth or pro) on a monthly or ltd (lifetime) billing cycle. It always pays from the wallet. Monthly plans renew; lifetime plans are a one-time invoice. The response carries only the invoice link.
POST /ai-insight/upgrade-plan moves an active monthly subscription to another monthly plan. Lifetime plans cannot be upgraded. subscriptionId is the payment provider's subscription ID. A prorated invoice is created immediately; check requiresPayment and invoiceUrl.
POST /ai-insight/purchase-mailboxes buys one-time analyses for selected mailboxes and returns a payment link, without a subscription. Nothing is analysed by this call. Subscribers should use Generate AI Insight Analysis.
This charges your wallet. Purchase AI Insight Plan and Purchase AI Insight For Mailboxes (with useWallet true) invoice the account owner and pay from wallet balance when it covers the cost, otherwise checkoutUrl is the link for the remainder. Upgrade AI Insight Plan invoices the prorated difference on the subscription.

Share a report#

POST /ai-insight/mailbox-analysis/{id}/share turns on a public link and returns it. Anyone with the link can read the report without signing in, and there is no endpoint to unshare it.
POST /ai-insight/mailbox-analysis/{id}/share-email emails the link to recipients. Addresses that could not be queued are returned in failedEmails.
GET /ai-insight/mailbox-analysis/{id}/public reads a shared analysis by ID. It is not limited to your workspace, so any valid API key can read any shared analysis whose ID it knows.
Related: Deliverability, Mailboxes, Wallet.
Previous
ZapCare
Next
Deliverability Tests
Built with