Zapmail
OverviewAPI Reference
OverviewAPI Reference
  1. Quick Setup
  • Domains
    • DNS
      • Get DNS Records
      • Add DNS Records
      • Check DNS Records
      • Add DNS Records to Multiple Domains
      • Update DNS Record
      • Delete DNS Record
    • Register
      • Search Available Domains
      • Buy Domains
      • Check Availability of Multiple Domains
      • Find Domains With AI
    • Connect
      • List Domain Connection Requests
      • Connect Domains
      • Get Nameservers to Connect a Domain
      • Verify Nameservers to Connect a Domain
      • Add Google Client ID to Domains
      • Remove Domain Connection Requests
    • Tag
      • List Domain Tags
      • Assign Tags to Domains
      • Create Domain Tags
      • Remove Tags from Domains
      • Delete Domain Tag
      • Update Domain Settings
    • Renewals
      • Search Domains Due for Renewal
      • Get Domain Renewal Prices
      • Renew Domains
      • Update Domain Auto-Renew
      • List Domains Due for Renewal
    • List Assignable Domains
      GET
    • Get Domain Health Score
      GET
    • Search Mailboxes and Domains
      GET
    • List Domains
      POST
    • Move Domains to Another Workspace
      POST
    • Remove Connected Domains
      DELETE
  • Mailbox
    • Get Authenticator Code
      GET
    • Get Mailbox
      GET
    • List Mailboxes
      POST
    • Provision Mailboxes
      POST
    • Update Mailboxes
      PUT
    • Schedule Mailbox Removal
      PUT
    • Retry Failed Mailboxes
      PUT
  • Export
    • List Third-Party Workspaces
      GET
    • Add Sequencer Details
      POST
    • Get Export Status
      GET
    • Update Sequencer Account Details
      PUT
    • Add Google Client ID To Domain
      POST
    • Connect Third-Party Account
      POST
    • Connect Mailboxes With Custom OAuth
      POST
    • Fetch Workspaces by App
      GET
    • Export Mailboxes
      POST
    • Update Third-Party Account
      PUT
    • Get Export Status
      GET
    • Export Mailboxes
      POST
  • Quick Setup
    • List Quick Setup Entries
      GET
    • Start Quick Setup
      POST
  • Pre-Warmed
    • List Pre-Warmed Domains
    • Count Pre-Warmed Domains
    • List Pre-Warmed Subscriptions
    • Assign Pre-Warmed Domains
    • Purchase Pre-Warmed Plan
  • Zapbox
    • List Zapbox Connected Accounts
    • List Zapbox Threads
    • Get Zapbox Thread Messages
    • Search Zapbox Emails
    • Send Zapbox Email
    • Apply Zapbox Email Action
    • Download Zapbox Attachment
    • Create Zapbox Label
    • Delete Zapbox Label
    • Rename Zapbox Label
  • User
    • Get Current User
  • Billing Details
    • Add Billing Details
    • Update Billing Details
  • Payments & Wallet
    • Get Wallet Balance
    • Add Wallet Balance
    • Enable or Disable Auto Recharge
    • Buy Add-On Mailboxes
    • Get Subscription Invoice URL
  • Subscriptions and Workspaces
    • List Workspace Members
    • List Workspace Invitations
    • List Workspaces
    • List Subscriptions
    • Create Workspace
    • Send Workspace Invitation
    • Cancel Subscription
    • List Subscription Mailboxes
    • Update Member Role
    • Update Workspace
    • Revoke Workspace Access
  • High Reputation Domains
    • List Aged Domains
    • Purchase Aged Domains
  • Deliverability
    • ZapShield
      • List ZapShield Subscriptions
      • List ZapShield Eligible Domains
      • List ZapShield Allocated Domains
      • Get ZapShield Available Slots
      • Cancel ZapShield Subscription
      • Purchase ZapShield
      • Upgrade ZapShield Plan
      • Allocate Domains to ZapShield
    • Deliverability Test
      • Get Deliverability Test Overall Report
      • List Deliverability Test Orders
      • Get Deliverability Test Report
      • List Deliverability Test Subscriptions
      • Get Deliverability Test Available Slots
      • List Deliverability Test Eligible Mailboxes
      • Purchase Deliverability Test
      • Generate Deliverability Test Spintax
      • Purchase Deliverability Test Plan
      • Cancel Deliverability Test Subscription
    • AI Insight
      • Get AI Insight Credits
      • Get AI Insight Analysis
      • Get Shared AI Insight Analysis
      • List AI Insight Eligible Mailboxes
      • Generate AI Insight Analysis
      • Calculate AI Insight Pricing
      • Purchase AI Insight Plan
      • Purchase AI Insight For Mailboxes
      • Email AI Insight Analysis
      • Share AI Insight Analysis
      • List AI Insight Analyses
      • Upgrade AI Insight Plan
    • Zap Care
      • List Zap Care Allocated Domains
      • Get Zap Care Available Slots
      • List Zap Care Subscriptions
      • List Zap Care Eligible Domains
      • Cancel Zap Care Subscription
      • Allocate Domains to Zap Care
      • Purchase Zap Care
  • Webhooks
    • List Webhook Event Types
    • List Webhook Endpoints
    • List Webhook Deliveries
    • Get Webhook Endpoint
    • Create Webhook Endpoint
    • Resend Webhook Delivery
    • Send Test Webhook Event
    • Update Webhook Endpoint
    • Delete Webhook Endpoint
  • Zap Sites
    • Get Zap Site
    • Create Zap Site
    • Regenerate Zap Site
    • Deploy Zap Site
    • Scan Zap Site Destination
    • Update Zap Site
  • Zapwarm
    • List mailboxes eligible for warmup
    • Get the Zapwarm quote for selected mailboxes
    • Start Zapwarm on selected mailboxes
    • Turn off Zapwarm on selected mailboxes
    • Edit Zapwarm settings
    • Get zapwarm score
  • ZapPulse
    • Get ZapPulse Overview
    • Get ZapPulse Insights
    • List ZapPulse Mailboxes
    • Get ZapPulse Mailbox Report
    • Create ZapPulse Report Share Link
  1. Quick Setup

Start Quick Setup

POST
https://api.zapmail.ai/api/v3/quick-setup
Registers new domains, buys the mailbox slots they need and creates the listed mailboxes on them in one request, optionally exporting the mailboxes to a connected sequencer and enabling ZapShield. Use it to go from nothing to sending mailboxes without calling each step yourself.
Before charging, every domain must be available and priced, the account needs an active plan and billing details, and the wallet must cover domains plus one add-on slot per requested mailbox (the pre-check assumes all mailboxes need a new slot). Failures return 400 and nothing is charged.
Asynchronous. The call returns once the invoice is created; domain registration, mailbox creation and export run afterwards. Poll List Quick Setup Entries: each mailbox entry moves through PENDING, DOMAIN_SUCCESS and MAILBOX_IN_PROGRESS, then reaches COMPLETED once the mailbox is ready (with exportApp it first passes MAILBOX_SUCCESS and EXPORT_IN_PROGRESS and completes when the export does). Failures stop at DOMAIN_FAILED, MAILBOX_FAILED or EXPORT_FAILED with an error.
Not available on pay-as-you-go accounts (400).
Mailbox keys must match domains exactly. A domain that already exists returns 400.
Charges your wallet. The workspace owner's wallet is charged when the invoice created by this call is finalized: domain registration for the requested years, the mailbox slots in slotsNeeded, and ZapShield when enabled. Registration and mailbox creation start once the invoice is paid.
Related: List Quick Setup Entries, List Mailboxes.

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success
application/json
Quick setup started.
Bodyapplication/json

🟠400BadRequest
🟠401Unauthorized
🟠403Forbidden
🟠422UnprocessableEntity
🟠429TooManyRequests
🔴500ServerError
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.zapmail.ai/api/v3/quick-setup' \
--header 'x-auth-zapmail;' \
--header 'x-workspace-key;' \
--header 'Content-Type: application/json' \
--data '{
  "domains": [
    {
      "domainName": "acme-mail.com",
      "years": 1
    }
  ],
  "mailboxes": {
    "acme-mail.com": [
      {
        "username": "jane",
        "firstName": "Jane",
        "lastName": "Doe"
      },
      {
        "username": "john",
        "firstName": "John",
        "lastName": "Smith"
      }
    ]
  },
  "exportApp": "SMARTLEAD",
  "enableDnsShield": false
}'
Response Response Example
200 - Success
{
  "status": 200,
  "message": "Quick setup initiated",
  "data": {
    "invoiceUrl": "https://invoice.stripe.com/i/acct_example/inv_example",
    "quickSetupBatchId": "c3b2a190-8d7e-4f6a-9b5c-4d3e2f1a0b9c",
    "slotsNeeded": 2
  }
}
Previous
List Quick Setup Entries
Next
List Pre-Warmed Domains
Built with