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
    • 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
    • dns
      • Get dns records
      • Add dns records
      • Update dns records
      • Delete dns records

    Zapmail Docs

    Introduction#

    Welcome to Zapmail! We're excited to help you begin your journey of creation and innovation. With the Zapmail API, you can seamlessly integrate your services and manage your domains, mailboxes, and much more.

    Authentication#

    Locating Your API Key#

    To kick off your experience with the Zapmail API platform, the initial step is to locate your unique API key. This key is crucial for validating your requests. To access your API key, follow these simple steps:
    1.
    Navigate to your Zapmail Dashboard.
    2.
    Select Settings.
    3.
    Go to Integrations.
    4.
    Click on API.
    Your API key can be found at: Zapmail Dashboard API Settings.
    Note: If you want to perform operations other than the primary workspace, you need to pass the workspace id and service provider(GOOGLE, MICROSOFT) in the headers as x-workspace-key and x-service-provider while making any API request.

    Base URL#

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

    Rate Limit#

    To ensure optimal performance, the rate limit for the Zapmail API is 5 requests per second and 20 requests per minute. Exceeding this limit will result in an error response, so please plan your API calls accordingly. Search available domain rate limit is limited to 10 request / 30 minutes.
    Re-export api is rate limited to 3 request per mailbox per week
    Note: Be mindful of the rate limit and consider implementing retry mechanisms in your application to avoid hitting the limit.
    Next
    Retrieve User Details
    Built with