Quick Setup

POST

/v2/quick-setup

Purchases domains, assigns mailboxes to them, and optionally exports those mailboxes to a third-party app — all in a single call.
When you request mailboxes. You are only charged for the difference — the slots you still need.
For example, if you request 10 mailboxes and already have 7 unused slots, you will only be charged for 3 additional slots.

The slot plan type is derived automatically from your active plan — you do not need to pass it.
Slot charges are included directly in the same Stripe invoice or checkout session as the domain purchase.

Request

Header Params

Body Params application/jsonRequired

Example

{
  "domains": [
    {
      "domainName": "example.com"
    }
  ],
  "mailboxes": {
    "example.com": [
      {
        "username": "john",
        "firstName": "John",
        "lastName": "Doe",
        "profilePicture": "https://example.com/avatar.png"
      }
    ]
  },
  "exportApp": "INSTANTLY",
  "enableDnsShield": false
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.zapmail.ai/api/v2/quick-setup' \
--header 'x-auth-zapmail;' \
--header 'x-workspace-id;' \
--header 'x-service-provider;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "domains": [
    {
      "domainName": "example.com"
    }
  ],
  "mailboxes": {
    "example.com": [
      {
        "username": "john",
        "firstName": "John",
        "lastName": "Doe",
        "profilePicture": "https://example.com/avatar.png"
      }
    ]
  },
  "exportApp": "INSTANTLY",
  "enableDnsShield": false
}'

Responses

🟢200Success

application/json

Body

Example

{
  "status": 200,
  "message": "Quick setup initiated",
  "data": {
    "quickSetupBatchId": "550e8400-e29b-41d4-a716-446655440000",
    "slotsNeeded": 3,
    "invoiceUrl": "https://invoice.stripe.com/i/acct_xxx/..."
  }
}

🟠400Bad Request

Modified at 2026-04-17 09:52:28

Retrieve User Details

Retrieve all workspaces