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

Versioning

The version of the Zapmail API is the second path segment of the URL: /api/v3 is version 3. v3 is the current version and receives new features. v2 is in maintenance. v1 is deprecated and has an announced end-of-life date. Use v3 for every new integration.

Supported versions#

VersionBase URLStatusEnd of life
v3https://api.zapmail.ai/api/v3Active since November 2026Not announced
v2https://api.zapmail.ai/api/v2Maintenance since November 2026January 2028
v1https://api.zapmail.ai/api/v1DeprecatedApril 2027
v1 reaches end of life in April 2027 and v2 in January 2028. Move to v3 before then. A request to a version after its end-of-life date is not guaranteed to work.
v3 has not entered maintenance and has no announced end-of-life date. When dates are set, they will be published here and in the Changelog.

Lifecycle phases#

Each version moves through three phases.
PhaseWhat it means
ActiveNew features, improvements and bug fixes. This is the current version.
MaintenanceCritical bug fixes and security patches only. No new features. Existing integrations keep working.
End of lifeNo support and no fixes. The version is taken offline after a minimum six-month notice.

Deprecation policy#

When a version or an endpoint is scheduled for removal:
1.
It is marked deprecated in the API reference with a written notice.
2.
At least six months of notice is given before removal.
3.
A migration guide is published for any breaking change.
4.
The version or endpoint keeps working until the stated removal date.

What v3 is#

v3 serves the full set of public endpoints under /api/v3: users, workspaces, billing, wallet, subscriptions, domains, mailboxes, dns, exports, prewarmed-domains, dns-shield (ZapShield), zap-care, placement-tests (Deliverability Tests), ai-insight, aged-domains, quick-setup, zap-sites, onebox (Zapbox), webhooks and global. It adds routes that v2 does not have and drops a few that v2 has. For the exact differences, see Migrating From v2 To v3.
Versions share authentication and rate limits. The same API key and headers work on every version, and the per-key limits are counted across all of them.

Migrate between versions#

v2 to v3: follow Migrating From v2 To v3. v2 routes are close to v3, and you can move one endpoint at a time.
v1 to v3: v1 used singular route prefixes. Rename them as below, then follow the v2 to v3 guide and check each endpoint on its reference page.
v1 prefixv3 prefix
/api/v1/user/api/v3/users
/api/v1/billing-details/api/v3/billing
/api/v1/mailbox/api/v3/mailboxes
/api/v1/domain/api/v3/domains
/api/v1/workspace/api/v3/workspaces
/api/v1/payment/api/v3/wallet
Related: Changelog, Migrating From v2 To v3, Introduction.
Previous
MCP
Next
Errors
Built with