Zapmail
latest
  • latest
  • v1
    Zapmail
    latest
    • latest
    • v1
    • Zapmail Docs
    • users
      • Retrieve User Details
        GET
    • workspaces
      • Retrieve all workspaces
        GET
      • Create new workspace
        POST
      • Update workspace
        PUT
    • billing
      • Add Billing Details
        POST
      • Update Billing Details
        PUT
    • mailbox
      • Retrieve All Mailboxes
        GET
      • Get Mailbox Details by ID
        GET
      • Assign New Mailboxes to Domains
        POST
      • Update mailbox
        PUT
      • Remove mailboxes on next renewal
        PUT
      • Get Authenticator code
        GET
      • Remove Mailboxes Instantly
        POST
    • payments & wallet
      • Add balance to wallet
        POST
      • Get wallet balance
        GET
      • Enable auto recharge
        POST
    • export
      • Export mailboxes
        POST
      • Add third party account details
        POST
      • Update third party account details
        PUT
    • subscriptions
      • Get all subscriptions
        GET
      • Cancel subscription
        POST
      • Upgrade existing subscription
        POST
    • domains
      • Retrieve All Domains
      • List Assignable Domains
      • Add DMARC record
      • Add Domain forwarding
      • Get Name servers to connect domain
      • Verify Name Server Propagation
      • Connect Domain with Zapmail
      • Enable email forwarding
      • Remove email forwarding
      • Enable catch all emails
      • Remove catch all emails
      • Check DNS records
      • Remove unused domains
      • Get available domains for registration
      • Get domains purchase payment link
      • Get domain connection requests
      • Remove domain connection requests
      • Connect Domain with Zapmail (New)
      • Add Google Client ID to Domain
      • Get availability of multiple domain names.
    • dns
      • Get dns records
      • Add dns records
      • Update dns records
      • Delete dns records

    Zapmail Docs

    Introduction#

    Welcome to the Zapmail API — your all-in-one solution for seamless domain and mailbox management. With our API, you can easily connect your services, automate workflows, and scale your email operations — from managing domains to handling mailbox exports and integrations, all in one place.

    Authentication#

    Getting Your API Key#

    Before making any API requests, you’ll need your unique API key. This key is used to authenticate and authorize your requests.
    To locate your API key:
    1.
    Navigate to your Zapmail Dashboard.
    2.
    Go to Settings.
    3.
    Open Integrations.
    4.
    Click on API.
    Your API key will be visible under Zapmail Dashboard → API Settings.
    Note:
    If you want to perform operations outside your primary workspace, include the following headers in your requests:
    x-workspace-key: The workspace ID you want to access.
    x-service-provider: The service provider (GOOGLE or MICROSOFT).

    Base URL#

    All Zapmail API requests should be sent to the following base URL:
    https://api.zapmail.ai/api

    Rate Limit#

    To ensure stable and consistent performance, the following rate limits apply:
    General Requests: 5 requests per second and 20 requests per minute.
    Domain Search: 10 requests every 30 minutes.
    Re-export Mailbox API: 3 requests per mailbox per week.
    If your application exceeds the rate limit, the API will return a 429 Too Many Requests response.
    {
      "status": 429,
      "message": "Too many requests"
    }
    Modified at 2025-10-13 08:46:46
    Next
    Retrieve User Details
    Built with