Zapmail
v1
  • latest
  • v1
    Zapmail
    v1
    • 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
    • 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
    • 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
        POST
    • subscriptions
      • Get all subscriptions
        GET
      • Cancel subscription
        POST
      • Upgrade existing subscription
        POST
    • domains
      • Retrieve All Domains
        GET
      • List Assignable Domains
        GET
      • Add DMARC record
        POST
      • Add Domain forwarding
        POST
      • Get Name servers to connect domain
        POST
      • Verify Name Server Propagation
        POST
      • Connect Domain with Zapmail
        POST
      • Enable email forwarding
        POST
      • Remove email forwarding
        DELETE
      • Enable catch all emails
        POST
      • Remove catch all emails
        DELETE
      • Check DNS records
        POST
      • Remove unused domains
        DELETE
      • Get available domains for registration
        POST
      • Get domains purchase payment link
        POST

    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 in the headers as x-workspace-key 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. Exceeding this limit will result in an error response, so please plan your API calls accordingly.
    Note: Be mindful of the rate limit and consider implementing retry mechanisms in your application to avoid hitting the limit.
    Modified at 2025-01-30 13:16:41
    Next
    Retrieve User Details
    Built with