Zapmail

https://docs.zapmail.ai
Admin
Zapmail is an API-first solution for seamless domain and mailbox management, enabling users to...
Tokens:138,177
Snippets:414
Trust Score:8.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Quick Setup Request Example

Source: https://docs.zapmail.ai/quick-setup-33476112e0

Example JSON payload for initiating a quick setup, including domain and mailbox configuration.

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

--------------------------------

### POST /quick setup

Source: https://docs.zapmail.ai/

Perform a quick setup operation.

```APIDOC
## POST /quick setup

### Description
Initiate the quick setup process for the user.

### Method
POST

### Endpoint
/quick setup
```

--------------------------------

### Success Response Example

Source: https://docs.zapmail.ai/purchase-plan-25780426e0

Example JSON response for a successful plan purchase.

```json
example:
                status: 200
                message: Placement test plan purchased successfully
                data:
                  subscription:
                    id: sub_abc123
                    subscriptionId: sub_1AbcDefGhiJklMnop
                    planType: STARTER
                    billingCycle: LTD
                    lookupKey: placement_test_starter_ltd
                    status: ACTIVE
                    monthlyCredits: 30
                    availableCredits: 30
                    periodStart: '2024-12-15T10:30:00.000Z'
                    periodEnd: '2025-12-15T10:30:00.000Z'
                    price: 99
                    currency: USD
                  invoice:
                    invoiceId: in_1AbcDefGhiJklMnop
                    invoiceUrl: <https://invoice.stripe.com/i/acct_xxx/test_xxx>
                    amount: 99
                    status: paid
                  walletBalance:
                    previousBalance: 500
                    amountDeducted: 99
                    currentBalance: 401
```

--------------------------------

### Subscription Upgrade Request Example

Source: https://docs.zapmail.ai/upgrade-existing-subscription-13489501e0

A JSON example of the request body required to upgrade a subscription.

```json
{
  "uniquePlanKey": "zap_mail_growth",
  "subscriptionId": "sub_123456789"
}
```

--------------------------------

### Success Response Example

Source: https://docs.zapmail.ai/get-prewarm-subscriptions-33586054e0

Example JSON response returned upon successfully fetching pre-warmed up subscriptions.

```json
{
  "status": 200,
  "message": "Pre-warmed up subscriptions fetched",
  "data": {
    "subscriptions": [
      {
        "id": "c2268925-57-44c3-a7b5-be1d98bc1694",
        "subscriptionId": "sub_1TAlLWPCpCE65rMoxGxme6",
        "subscriptionStatus": "ACTIVE",
        "plan": "Pro",
        "uniquePlanKey": "prewarmed_up_pro_monthly_microsoft",
        "price": 180,
        "totalMailboxQuantity": 30,
        "periodStart": "2026-04-14T00:36:46.000Z",
        "periodEnd": "2026-05-14T00:36:46.000Z",
        "subscriptionCreationDate": "2026-03-14T00:36:46.000Z",
        "paymentFailureMessage": null,
        "billingCycle": "MONTHLY",
        "serviceProvider": "GOOGLE",
        "domains": [
          {
            "id": "923b513f-9d13-407d-998b-efb7096c64bf",
            "domain": "yourcompanynow.info"
          }
        ],
        "invoiceDetails": "https://invoice.stripe.com/..."
      }
    ],
    "total": 23,
    "currentPage": 1,
    "nextPage": 2,
    "totalPages": 1
  }
}
```

--------------------------------

### Subscription Data Examples

Source: https://docs.zapmail.ai/get-subscriptions-25781447e0

Example data structures for various subscription states including active and cancelled plans.

```json
price: 299900
                    billingCycle: LTD
                    totalSlots: '500'
                    totalUsedSlots: 350
                    planType: PRO
                  - id: sub-uuid-2
                    subscriptionId: sub_1AbcDefGhiJklMnop
                    status: ACTIVE
                    lookupKey: zap_dns_shield
                    periodStart: '2024-02-01T00:00:00.000Z'
                    periodEnd: '2024-03-01T00:00:00.000Z'
                    createdAt: '2024-02-01T08:15:00.000Z'
                    updatedAt: '2024-02-01T08:15:00.000Z'
                    cancelledByUser: false
                    invoiceLink: <https://invoice.stripe.com/i/acct_yyyy/test_yyyy>
                    paymentFailureMessage: null
                    price: 15000
                    billingCycle: MONTHLY
                    totalSlots: '999999'
                    totalUsedSlots: 50
                    planType: null
                  - id: sub-uuid-3
                    subscriptionId: ltd_starter_def456uvw
                    status: CANCELLED
                    lookupKey: dns_shield_starter_ltd
                    periodStart: '2023-12-01T00:00:00.000Z'
                    periodEnd: '2024-01-15T00:00:00.000Z'
                    createdAt: '2023-12-01T12:00:00.000Z'
                    updatedAt: '2024-01-15T09:00:00.000Z'
                    cancelledByUser: true
                    invoiceLink: <https://invoice.stripe.com/i/acct_zzzz/test_zzzz>
                    paymentFailureMessage: null
                    price: 9900
                    billingCycle: LTD
                    totalSlots: '30'
                    totalUsedSlots: 30
                    planType: STARTER
```

--------------------------------

### Not Found Error Response Example

Source: https://docs.zapmail.ai/retrieve-domain-health-score-25772162e0

Example JSON response for a 404 Not Found status.

```json
example:
                status: 404
                message: Domain not found or access denied
                data: null
```

--------------------------------

### API Response Examples

Source: https://docs.zapmail.ai/list-all-third-party-accounts-34432755e0

JSON examples for successful and error responses from the third-party accounts endpoint.

```json
status: 200
message: Accounts fetched
data:
  accounts:
    - id: uuid
      accountId: uuid
      email: user@example.com
      apiKey: null
      appName: INSTANTLY
      selectedOrgId: null
      error: null
      createdAt: '2024-01-01T00:00:00.000Z'
      updatedAt: '2024-01-01T00:00:00.000Z'
```

```json
status: 400
message: '`app` query parameter is required'
data: null
```

```json
status: 422
message: >-
  Multiple <APP> accounts exist for this workspace —
  <accountId|thirdPartyAccountId> is required.
data: null
```

--------------------------------

### Subscription Success Response Example

Source: https://docs.zapmail.ai/get-subscriptions-25778521e0

Example of a successful subscription data object returned by the API.

```yaml
                    usedCredits: 85
                    availableCredits: 115
                    periodStart: '2024-12-01T00:00:00.000Z'
                    periodEnd: '2025-01-01T00:00:00.000Z'
                    price: 49
                    currency: USD
                    createdAt: '2024-11-15T14:20:00.000Z'
                    cancelledByUser: false
```

--------------------------------

### Mailbox Export Request Example

Source: https://docs.zapmail.ai/export-mailboxes-13490737e0

Example payload for initiating a mailbox export process.

```json
example:
  apps:
    - REACHINBOX
  ids:
    - a66ccca7-d465-464a-887b-90bce6d09bbb
  excludeIds: []
  tagIds: []
  status: ''
  contains: ''
  thirdPartyAccountId: 3f9c2a7e-6d14-4b8a-9f2e-1c7d5e8b4a91
```

--------------------------------

### Example Request for Name Server Verification

Source: https://docs.zapmail.ai/verify-name-server-propagation-13520984e0

A JSON payload example for the domain verification request.

```json
{
    "domainName": "yourdomain.com"
}
```

--------------------------------

### DNS Records Success Response Example

Source: https://docs.zapmail.ai/get-dns-records-13627177e0

Example JSON response returned when DNS records are fetched successfully.

```json
status: 200
message: DNS records fetched successfully
data:
  records:
    - id: c1a9e4b2-7a5f-4f2a-8f0c-6d9e2a1b5f3e
      assignedDomainId: d4b7f2c3-1f2a-4e9b-8c6d-2a3f4b5c6d7e
      cdfRecordId: f9a2b4c6-3d1e-4f7b-9a0d-1c2b3e4f5a6b
      cdfResponse:
        id: f9a2b4c6-3d1e-4f7b-9a0d-1c2b3e4f5a6b
        name: dummy.com.dns-records.test
        type: A
        content: 123.123.123.123
      recordType: A
      value: 123.123.123.123
      host: dummy.com
      priority: null
      createdAt: '2025-01-31T09:03:21.984Z'
      updatedAt: '2025-01-31T09:03:21.984Z'
      deletedAt: null
    - id: e2b3c4d5-6f7a-4b8c-9d0e-1f2a3b4c5d6e
      assignedDomainId: d4b7f2c3-1f2a-4e9b-8c6d-2a3f4b5c6d7e
      cdfRecordId: a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d
      cdfResponse:
        id: a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d
        name: mail.dummy.com.dns-records.test
        type: CNAME
        content: dummy-mailserver.com
      recordType: CNAME
      value: dummy-mailserver.com
      host: mail.dummy.com
      priority: null
      createdAt: '2025-01-31T09:03:21.984Z'
      updatedAt: '2025-01-31T09:03:21.984Z'
      deletedAt: null
  disabledRecords:
    - id: b1c2d3e4-5f6a-7b8c-9d0e-1f2a3b4c5d6e
      zone_id: z1a2b3c4-5d6e-7f8a-9b0c-1d2e3f4a5b6c
      name: mail.dummy.com.dns-records.test
      type: CNAME
      content: dummy-mailserver.com
      ttl: 1
    - id: c2d3e4f5-6a7b-8c9d-0e1f-2a3b4c5d6e7f
      zone_id: z1a2b3c4-5d6e-7f8a-9b0c-1d2e3f4a5b6c
      name: _dmarc.dns-records.test
      type: TXT
      content: >-
        v=DMARC1; p=reject; rua=mailto:dummy@dummy.com;
        ruf=mailto:dummy@dummy.com; fo=0; pct=100; rf=afrf;
        ri=604800; sp=reject; aspf=r; adkim=r
      ttl: 1
```

--------------------------------

### Unprocessable Entity Response Example

Source: https://docs.zapmail.ai/update-third-party-account-details-13490787e0

Example response returned when multiple accounts exist for a workspace, requiring an accountId.

```json
{
                "status": 422,
                "message": "Multiple <APP> accounts exist for this workspace —\n                  <accountId|thirdPartyAccountId> is required.",
                "data": null
              }
```

--------------------------------

### Available Domains API Response Example

Source: https://docs.zapmail.ai/get-available-domains-25772286e0

Example JSON response structure for a successful retrieval of available aged domains.

```json
example:
                status: 200
                message: Available aged domains retrieved successfully
                data:
                  domains:
                    - id: aged_domain_123
                      domainName: techstartup.com
                      price: 299
                      qualityScore: 85
                      domainAgeYears: 12
                      registrationDate: '2012-03-15T00:00:00.000Z'
                      expirationDate: '2025-03-15T00:00:00.000Z'
                      tld: com
                      category: technology
                      status: available
                      metrics:
                        backlinks: 1250
                        referringDomains: 85
                        domainAuthority: 42
                        spamScore: 2
                        trustFlow: 38
                        citationFlow: 41
                      features:
                        - Clean history
                        - No spam records
                        - Good backlink profile
                        - Established brand name
                      batchNo: 45
                      createdAt: '2024-01-15T10:30:00.000Z'
                    - id: aged_domain_124
                      domainName: healthblog.net
                      price: 450
                      qualityScore: 92
                      domainAgeYears: 15
                      registrationDate: '2009-07-22T00:00:00.000Z'
                      expirationDate: '2025-07-22T00:00:00.000Z'
                      tld: net
                      category: health
                      status: available
                      metrics:
                        backlinks: 3400
                        referringDomains: 210
                        domainAuthority: 58
                        spamScore: 1
                        trustFlow: 52
                        citationFlow: 55
                      features:
                        - Premium quality
                        - High authority
                        - Excellent backlink profile
                        - Long history
                      batchNo: 45
                      createdAt: '2024-01-15T10:30:00.000Z'
                  pagination:
                    currentPage: 1
                    totalPages: 8
                    totalCount: 78
                    limit: 10
                    hasNextPage: true
                    hasPreviousPage: false
```

--------------------------------

### OpenAPI Schema and Response Examples

Source: https://docs.zapmail.ai/global-mailbox-domain-search-26754309e0

Defines the structure for mailbox domain search results and pagination, along with success and validation error response examples.

```yaml
type: string
name:
  type: string
required:
  - id
  - name
x-apidog-orders:
  - id
  - name
x-apidog-orders:
  - id
  - first_name
  - last_name
  - domain
  - username
  - workspace_id
  - service_provider
  - mailboxWorkspace
required:
  - example.com
  - another-domain.com
x-apidog-orders:
  - example.com
  - another-domain.com
pagination:
  type: object
  properties:
    totalRecords:
      type: integer
    totalPages:
      type: integer
    currentPage:
      type: integer
    limit:
      type: integer
    hasNextPage:
      type: boolean
    hasPreviousPage:
      type: boolean
  required:
    - totalRecords
    - totalPages
    - currentPage
    - limit
    - hasNextPage
    - hasPreviousPage
  x-apidog-orders:
    - totalRecords
    - totalPages
    - currentPage
    - limit
    - hasNextPage
    - hasPreviousPage
required:
  - mailboxPerDomain
  - pagination
x-apidog-orders:
  - mailboxPerDomain
  - pagination
required:
  - status
  - message
  - data
x-apidog-orders:
  - status
  - message
  - data
example:
  status: 200
  message: Search completed successfully
  data:
    mailboxPerDomain:
      example.com:
        - id: uuid-1
          first_name: John
          last_name: Doe
          domain: example.com
          username: john
          workspace_id: workspace-uuid
          service_provider: GOOGLE
          mailboxWorkspace:
            id: workspace-uuid
            name: My Workspace
        - id: uuid-2
          first_name: Jane
          last_name: Smith
          domain: example.com
          username: jane
          workspace_id: workspace-uuid
          service_provider: GOOGLE
          mailboxWorkspace:
            id: workspace-uuid
            name: My Workspace
      another-domain.com:
        - id: uuid-3
          first_name: Bob
          last_name: Wilson
          domain: another-domain.com
          username: bob
          workspace_id: workspace-uuid-2
          service_provider: MICROSOFT
          mailboxWorkspace:
            id: workspace-uuid-2
            name: Another Workspace
    pagination:
      totalRecords: 3
      totalPages: 1
      currentPage: 1
      limit: 50
      hasNextPage: false
      hasPreviousPage: false
headers: {}
x-apidog-name: Success
'422':
  description: ''
  content:
    application/json:
      schema:
        type: object
        properties:
          message:
            type: string
        required:
          - message
        x-apidog-orders:
          - message
      example:
        message: contains must be a string
  headers: {}
```

--------------------------------

### POST /quick-setup

Source: https://docs.zapmail.ai/quick-setup-33476112e0

Initiates the quick setup process for specified domains and mailboxes.

```APIDOC
## POST /quick-setup

### Description
Initiates a quick setup batch for the provided domains and mailboxes. Returns a batch ID and invoice URL required to proceed.

### Method
POST

### Endpoint
/quick-setup

### Request Body
- **domains** (array) - Required - List of domain objects
- **mailboxes** (object) - Required - Map of domain names to mailbox configurations
- **enableDnsShield** (boolean) - Required - Toggle for DNS shield protection

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

### Response
#### Success Response (200)
- **status** (integer) - Status code
- **message** (string) - Success message
- **data** (object) - Contains quickSetupBatchId, slotsNeeded, and invoiceUrl

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

--------------------------------

### get emails from a thread

Source: https://docs.zapmail.ai/llms.txt

Get all emails in a specific conversation thread.

```APIDOC
## get emails from a thread

### Description
Get all emails in a specific conversation thread
```

--------------------------------

### Unauthorized Error Example

Source: https://docs.zapmail.ai/purchase-plan-25780426e0

Example JSON response for a 401 Unauthorized error.

```json
example:
                status: 401
                message: API key is required
                errorId: uuid-v4-error-id
```

--------------------------------

### POST /v2/quick-setup

Source: https://docs.zapmail.ai/quick-setup-33476112e0

Purchases domains, assigns mailboxes to them, and optionally exports those mailboxes to a third-party app. Charges are applied for the difference in required mailbox slots.

```APIDOC
## POST /v2/quick-setup

### Description
Purchases domains, assigns mailboxes to them, and optionally exports those mailboxes to a third-party app. When requesting mailboxes, you are only charged for the difference in slots needed.

### Method
POST

### Endpoint
/v2/quick-setup

### Parameters
#### Header Parameters
- **x-auth-zapmail** (string) - Required - Authentication token
- **x-workspace-key** (string) - Optional - Workspace identifier
- **x-service-provider** (string) - Optional - Service provider identifier

#### Request Body
- **domains** (array) - Required - List of domains to purchase
  - **domainName** (string) - Required
- **mailboxes** (object) - Required - Map of domain names to mailbox configurations
  - **[domainName]** (array) - Required
    - **username** (string) - Required
    - **firstName** (string) - Required
    - **lastName** (string) - Required
    - **profilePicture** (string) - Optional
- **exportApp** (string) - Optional - Third-party application to export mailboxes to (e.g., REACHINBOX, INSTANTLY, SMARTLEAD, etc.)
```

--------------------------------

### OpenAPI Specification for Quick Setup

Source: https://docs.zapmail.ai/quick-setup-33476112e0

Defines the POST /v2/quick-setup endpoint, including required headers and the request body schema for domains, mailboxes, and export applications.

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v2/quick-setup:
    post:
      summary: Quick Setup
      deprecated: false
      description: >-
        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.
      tags:
        - quick setup
      parameters:
        - name: x-auth-zapmail
          in: header
          description: ''
          required: true
          example: ''
          schema:
            type: string
        - name: x-workspace-key
          in: header
          description: ''
          required: false
          example: ''
          schema:
            type: string
        - name: x-service-provider
          in: header
          description: ''
          required: false
          example: ''
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                domains:
                  type: array
                  items:
                    type: object
                    properties:
                      domainName:
                        type: string
                    x-apidog-orders:
                      - domainName
                    required:
                      - domainName
                mailboxes:
                  type: object
                  properties:
                    example.com:
                      type: array
                      items:
                        type: object
                        properties:
                          username:
                            type: string
                          firstName:
                            type: string
                          lastName:
                            type: string
                          profilePicture:
                            type: string
                        x-apidog-orders:
                          - username
                          - firstName
                          - lastName
                          - profilePicture
                        required:
                          - username
                          - firstName
                          - lastName
                  required:
                    - example.com
                  x-apidog-orders:
                    - example.com
                exportApp:
                  type: string
                  enum:
                    - REACHINBOX
                    - INSTANTLY
                    - SMARTLEAD
                    - REPLY_IO
                    - QUICKMAIL
                    - EMELIA
                    - FIRSTQUADRANT
                    - WARMY
                    - SUPERAGI
                    - PIPL
                    - LUELLA
                    - MASTER_INBOX
                    - RECRUITERFLOW
                    - SAILE
                    - SNOV
                    - MAILTOASTER
                    - MANYREACH
                    - COLDSTATS
                    - BRANDJET
                    - HOTHAWK
                    - MAILIVERY
                    - EMAILGUARD
                    - UNIPILE
                    - APOLLO
                    - TRULYINBOX
                  x-apidog-enum:
                    - value: REACHINBOX
                      name: ''
                      description: ''
                    - value: INSTANTLY
                      name: ''
                      description: ''
                    - value: SMARTLEAD
                      name: ''
                      description: ''
                    - value: REPLY_IO
                      name: ''
                      description: ''
                    - value: QUICKMAIL
                      name: ''
                      description: ''
                    - value: EMELIA
                      name: ''
                      description: ''
                    - value: FIRSTQUADRANT
                      name: ''
                      description: ''
                    - value: WARMY
                      name: ''
                      description: ''
                    - value: SUPERAGI
                      name: ''
                      description: ''
                    - value: PIPL
                      name: ''
                      description: ''
                    - value: LUELLA
                      name: ''
```

--------------------------------

### GET /v2/prewarmed-domains/count

Source: https://docs.zapmail.ai/get-available-domains-count-26754452e0

Get count of available pre-warmed up domains (not yet sold) by service provider.

```APIDOC
## GET /v2/prewarmed-domains/count

### Description
Get count of available pre-warmed up domains (not yet sold) by service provider.

### Method
GET

### Endpoint
https://api.zapmail.ai/api/v2/prewarmed-domains/count

### Parameters
#### Header Parameters
- **x-auth-zapmail** (string) - Required - API key for authentication.

### Response
#### Success Response (200)
- **status** (integer) - Status code.
- **message** (string) - Success message.
- **data** (object) - Object containing domain counts.
  - **google** (integer) - Count of Google domains.
  - **microsoft** (integer) - Count of Microsoft domains.

#### Response Example
{
  "status": 200,
  "message": "Pre-warmed up domains count fetched",
  "data": {
    "google": 150,
    "microsoft": 75
  }
}
```

--------------------------------

### Quick Setup Success Response

Source: https://docs.zapmail.ai/quick-setup-33476112e0

Successful response structure containing the batch ID, required slots, and invoice URL.

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

--------------------------------

### Quick Setup Bad Request Response

Source: https://docs.zapmail.ai/quick-setup-33476112e0

Error response returned when the request is invalid, such as missing mailbox definitions.

```json
{
  "status": 400,
  "message": "Domain \"example.com\" has no mailboxes defined",
  "errorId": "550e8400-e29b-41d4-a716-446655440000"
}
```

--------------------------------

### Internal Server Error Example

Source: https://docs.zapmail.ai/purchase-plan-25780426e0

Example JSON response for a 500 Internal Server Error.

```json
example:
                status: 500
                message: Failed to retrieve invoice from subscription
                errorId: uuid-v4-error-id
```

--------------------------------

### Example Request Body

Source: https://docs.zapmail.ai/get-domains-purchase-payment-link-13521209e0

JSON payload for requesting a domain purchase payment link.

```json
{
  "domains": [
    { "domainName": "example.com", "years": 1 },
    { "domainName": "example.io", "years": 1 }
  ],
  "useWallet": true,
  "enableDnsShield": true
}
```

--------------------------------

### Bad Request Error Example

Source: https://docs.zapmail.ai/purchase-plan-25780426e0

Example JSON response for a 400 Bad Request error.

```json
example:
                status: 400
                message: planName is required
                errorId: uuid-v4-error-id
```

--------------------------------

### Example Request Body

Source: https://docs.zapmail.ai/connect-domain-with-zapmail-13521006e0

A sample JSON payload for the domain connection request.

```json
{
    "domainName": "yourdomain.com",
}
```

--------------------------------

### Unauthorized Error Response Example

Source: https://docs.zapmail.ai/get-subscriptions-25778521e0

Example of the JSON structure returned when an API key is missing or invalid.

```yaml
                status: 401
                message: API key is required
                errorId: uuid-v4-error-id
```

--------------------------------

### Domain Configuration Example

Source: https://docs.zapmail.ai/get-eligible-domains-25781361e0

Represents the structure of a domain configuration object within the API response.

```yaml
catchAllEmailAdded: true
nameServers:
  - ns1.provider.com
  - ns2.provider.com
unusedDomainNotification: false
dnsManagedBy: CLOUDFLARE
maskForwarding: false
isWarmedUp: false
autoRenew: true
registeredOn: '2023-01-15T00:00:00.000Z'
expireOn: '2025-01-15T00:00:00.000Z'
dnsAuthenticationInProgress: false
cloudflareCredentialsId: cf-cred-uuid
expectedNameServers:
  - ns1.expected.com
  - ns2.expected.com
isaftermarket: false
assignedMailboxesCount: 5
transferRequired: true
transferInternally: false
isCloudflareConnected: true
dnsShieldUpdateInProgress: null
dnsShieldEnabled: false
dnsBoxInvalidNameServers: false
```

--------------------------------

### OpenAPI Workspace Creation Response Examples

Source: https://docs.zapmail.ai/create-new-workspace-13489947e0

Defines the expected JSON structure for successful workspace creation and conflict error responses.

```yaml
              examples:
                '1':
                  summary: Success
                  value:
                    status: 200
                    message: Workspace created successfully
                    data:
                      id: f69cde69-ab43-4168-b78b-77a50a02b8dd
                      name: New Workspace
                      userId: fbf34af0-be3b-4add-bd97-462e2471f65d
                      updatedAt: '2024-08-09T06:10:04.855Z'
                      createdAt: '2024-08-09T06:10:04.855Z'
                      deletedAt: null
                '2':
                  summary: 409 - Workspace already exists
                  value:
                    status: 409
                    message: Workspace with the same name already exists
                    errorId: 8b45f1a8-6ae8-47eb-8f99-b2eac942853e
```

```yaml
          example:
                status: 409
                message: Workspace with the same name already exists
                errorId: 5ec7b4e6-3693-49f5-ade3-84158c6c2daa
```

--------------------------------

### Success Response Example

Source: https://docs.zapmail.ai/export-mailboxes-13490737e0

Response returned when the export process is successfully initiated.

```json
example:
  status: 200
  message: Mailboxes export is started. It may take sometime to export
  data: null
```

--------------------------------

### Error Response Examples

Source: https://docs.zapmail.ai/get-prewarmed-domains-25774188e0

Examples of error responses for Bad Request, Unauthorized, and Internal Server Error scenarios.

```json
status: 400
message: Invalid pagination parameters
errorId: uuid-v4-error-id
```

```json
status: 401
message: Invalid API key
errorId: uuid-v4-error-id
```

```json
status: 500
```

--------------------------------

### Success Response Example

Source: https://docs.zapmail.ai/get-placement-test-orders-25779469e0

Represents a successful retrieval of placement test orders, including pagination metadata and order details.

```yaml
example:
  status: 200
  message: Placement test orders retrieved successfully
  data:
    orders:
      - id: order_abc123
        cartOrderId: cart_xyz789
        testName: Monthly Test - December 2024
        mailboxId: mailbox_def456
        mailboxEmail: user@example.com
        status: COMPLETED
        billingCycle: MONTHLY
        subscriptionId: sub_1AbcDefGhiJklMnop
        results:
          inboxRate: 88.5
          spamRate: 11.5
          score: 85.2
        seedAccounts:
          - google
          - microsoft365
        spamassassin: true
        blacklist: true
        createdAt: '2024-12-01T10:00:00.000Z'
        completedAt: '2024-12-01T10:45:00.000Z'
      - id: order_ghi789
        cartOrderId: cart_uvw345
        testName: Weekly Test
        mailboxId: mailbox_jkl012
        mailboxEmail: sales@example.com
        status: PENDING
        billingCycle: ONE_TIME
        seedAccounts:
          - google
          - microsoft365
        spamassassin: true
        blacklist: true
        createdAt: '2024-12-15T14:30:00.000Z'
        completedAt: null
    pagination:
      currentPage: 1
      totalPages: 5
      totalCount: 48
      limit: 10
      hasNextPage: true
      hasPreviousPage: false
```

--------------------------------

### Success response example

Source: https://docs.zapmail.ai/update-user-role-26769213e0

The JSON structure returned upon a successful role update.

```json
{
    "status": 200,
    "message": "Member role updated successfully",
    "data": {
        "id": "",
        "role": "ADMIN"
    }
}
```

--------------------------------

### Error Response Examples

Source: https://docs.zapmail.ai/get-allocated-domains-for-subscription-25781672e0

Examples of 400 Bad Request and 401 Unauthorized error responses returned by the API.

```yaml
              example:
                status: 400
                message: Validation error
                data:
                  errorId: unique-error-id
                  errors:
                    - field: limit
                      message: limit must be a positive integer between 1 and 100
```

```yaml
              example:
                status: 401
                message: Invalid API key
                data:
                  errorId: unique-error-id
```

--------------------------------

### Internal Server Error Response Example

Source: https://docs.zapmail.ai/cancel-subscription-25783127e0

Example JSON structure for a 500 Internal Server Error response.

```yaml
example:
                status: 500
                message: Internal server error
                data:
                  errorId: unique-error-id
```

--------------------------------

### POST /v2/domains/available

Source: https://docs.zapmail.ai/get-available-domains-for-registration-13521189e0

Returns a list of domains that are available for registration, along with the exact match and a list of similar domains for a given set of TLDs and years of registration.

```APIDOC
## POST /v2/domains/available

### Description
This endpoint returns a list of domains that are available for registration, along with the exact match and a list of similar domains for a given set of TLDs and years of registration. Note: Only the following TLDs are allowed for registration: com, net, org, biz, live, info.

### Method
POST

### Endpoint
/v2/domains/available

### Parameters
#### Header Parameters
- **x-auth-zapmail** (string) - Required - Authentication header
- **x-workspace-key** (string) - Optional - Workspace key
- **x-service-provider** (string) - Optional - Service provider identifier

#### Request Body
- **domainName** (string) - Required - Domain name to check availability for and fetch similar domains.
- **tlds** (array) - Optional - List of TLDs to target (eg. "com", "live", "info", etc)
- **years** (integer) - Optional - Number of years to register the domain for. (Default is 1 year)

### Request Example
{
  "domainName": "company.com",
  "tlds": ["com"],
  "years": 1
}

### Response
#### Success Response (200)
- **status** (integer) - Response status code
- **message** (string) - Response message
- **data** (object) - Contains availableDomains array

#### Response Example
{
  "status": 200,
  "message": "Success",
  "data": {
    "availableDomains": [
      {
        "domainName": "company.com",
        "status": "available",
        "domainPrice": "10.00",
        "renewPrice": "12.00"
      }
    ]
  }
}
```

--------------------------------

### POST /purchase-prewarmed-subscription

Source: https://docs.zapmail.ai/purchase-prewarmed-subscription-25774263e0

Initiates the purchase of a prewarmed-up addon subscription.

```APIDOC
## POST /purchase-prewarmed-subscription

### Description
Initiates the purchase of a prewarmed-up addon subscription for the user's account.

### Method
POST

### Endpoint
https://api.zapmail.ai/api/purchase-prewarmed-subscription

### Parameters
#### Query Parameters
- **planType** (string) - Required - The type of plan to purchase (e.g., starter).

#### Header Parameters
- **x-auth-zapmail** (string) - Required - Authentication token.
- **x-service-provider** (string) - Required - Service provider identifier.
- **x-workspace-key** (string) - Optional - Workspace key identifier.

### Response
#### Success Response (200)
- **message** (string) - Success message.
- **paymentLink** (string) - URL to complete the payment.
- **useWallet** (boolean) - Indicates if the wallet should be used.

#### Response Example
{
  "message": "Prewarmed-Up Addon purchase is processed successfully",
  "paymentLink": "https://invoice.stripe.com/i/acct_1QKb...",
  "useWallet": true
}
```
Tokens:
Raw