Zapmail
Overview
API Reference
Overview
API Reference
  1. Overview
  • 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. Overview

Introduction

The Zapmail API lets you automate what you do in the Zapmail dashboard: find, buy and connect domains, provision Google Workspace and Microsoft 365 mailboxes, configure DNS, export mailboxes to sequencers, manage workspaces and teammates, and pay for it all from a prepaid wallet. Every request is plain HTTPS with JSON bodies.
https://api.zapmail.ai/api/v3
There is no sandbox or test mode. Every request runs against your live account, and endpoints that buy something charge your wallet or card for real. Each endpoint page states who is charged and when.

How Zapmail works#

Zapmail is used as a workflow, not as isolated endpoints.
1
Fund the account
Add billing details and top up the wallet. Domain purchases, renewals and mailbox add-ons draw on this balance.
2
Get domains and mailboxes
Search for and buy domains, or connect ones you own. Then provision mailboxes on them. Both are processed asynchronously, so you poll until the resource is ACTIVE.
3
Operate and optimize
Export mailboxes to a sequencer, manage teammates through workspaces, read replies in Zapbox, and monitor deliverability with ZapShield, Zap Care and Deliverability Tests.

Choose your path#

Quickstart
Buy a domain and provision your first mailboxes end to end, with curl, JavaScript and Python.
Authentication
API keys, workspace scoping and key security.
Errors
Error formats, status codes and what to retry.
Versioning
Which API versions are supported and for how long.
MCP
Connect an AI assistant to Zapmail over OAuth instead of calling the REST API.
API reference
Request and response details for every endpoint.
The same section also covers Rate Limits, Pagination, the Changelog and Migrating From v2 To v3.

Conventions that apply to every endpoint#

TopicBehaviour
Base URLhttps://api.zapmail.ai/api/v3
Authenticationx-auth-zapmail header with your API key on every request. See Authentication.
WorkspaceOptional x-workspace-key header to act in a workspace other than your primary one.
Request bodiesJSON. Send Content-Type: application/json.
Success responsesMost return { "status", "message", "data" }. A few return a different body and say so on their endpoint page.
Error responses{ "status", "message", "errorId" }. See Errors.
Listspage and limit, with defaults that vary per endpoint. See Pagination.
Rate limits5 requests per second and 200 per minute per API key. See Rate Limits.
MoneyAmounts are in USD.
RetriesThe API has no idempotency keys. Check state before you repeat a request that buys something.
A typical success response:
{
  "status": 200,
  "message": "Domains fetched successfully",
  "data": {}
}
A typical error response:
{
  "status": 401,
  "message": "Invalid API key",
  "errorId": "6c0a0a4d-4a3e-4a9d-bf5d-0a2f7f5f4f31"
}
Several endpoints that move money return a body without status or data: wallet balance and top-up, Pre-Warmed purchase, quick setup, domain purchase and ZapShield purchase. The endpoint page for each one shows the exact shape.

Mailbox providers#

Accounts work with Google Workspace and Microsoft 365 mailboxes together. Domains, mailboxes and subscriptions carry a serviceProvider field with the value GOOGLE, MICROSOFT or null.
null can appear on subscriptions and on domains that have no mailbox yet. Do not treat null as Microsoft.
A domain takes the provider of the first mailbox assigned to it, so do not cache a domain's provider before it has mailboxes.
You no longer send a provider header. See the Changelog entry for October 13, 2026.

Browse by capability#

Domains
Search, buy, connect, check, tag and renew domains.
Mailboxes
Provision, assign, list, update, retry and remove mailboxes.
Pre-Warmed
Browse pre-warmed inventory, buy plans and assign domains.
Deliverability
ZapShield, Zap Care, Deliverability Tests and AI Insight.
Zapwarm
Check eligible mailboxes, get quotes, start and stop warmup, and edit settings.
ZapPulse
Monitor sender reputation with overview, insights and per-mailbox reports.
Export to Sequencer
Connect sequencer accounts and export mailbox credentials.
Zapbox
Search inboxes, read threads, send messages and manage labels.
Team Management
Workspaces, members and invitations.
Understanding Zapmail billing
How billing details, the wallet and subscriptions fit together.
Wallet
Top up the balance, enable auto recharge and fetch invoices.
Webhooks
Receive events at your own endpoint instead of polling.

Before you build#

Long-running work (domain registration, mailbox creation, exports) is asynchronous. Poll the resource, or subscribe to Webhooks, instead of assuming the first response means the work is done.
The API has no SDKs. Call it over HTTPS from any language.
If something behaves differently from these pages, contact support at support@zapmail.ai and include the errorId from the response.
Next
Quickstart
Built with