# Quick Setup

## OpenAPI Specification

```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: ''
                      description: ''
                    - value: MASTER_INBOX
                      name: ''
                      description: ''
                    - value: RECRUITERFLOW
                      name: ''
                      description: ''
                    - value: SAILE
                      name: ''
                      description: ''
                    - value: SNOV
                      name: ''
                      description: ''
                    - value: MAILTOASTER
                      name: ''
                      description: ''
                    - value: MANYREACH
                      name: ''
                      description: ''
                    - value: COLDSTATS
                      name: ''
                      description: ''
                    - value: BRANDJET
                      name: ''
                      description: ''
                    - value: HOTHAWK
                      name: ''
                      description: ''
                    - value: MAILIVERY
                      name: ''
                      description: ''
                    - value: EMAILGUARD
                      name: ''
                      description: ''
                    - value: UNIPILE
                      name: ''
                      description: ''
                    - value: APOLLO
                      name: ''
                      description: ''
                    - value: TRULYINBOX
                      name: ''
                      description: ''
                enableDnsShield:
                  type: boolean
              required:
                - domains
                - mailboxes
                - enableDnsShield
              x-apidog-orders:
                - domains
                - mailboxes
                - exportApp
                - enableDnsShield
            example:
              domains:
                - domainName: example.com
              mailboxes:
                example.com:
                  - username: john
                    firstName: John
                    lastName: Doe
                    profilePicture: https://example.com/avatar.png
              exportApp: INSTANTLY
              enableDnsShield: false
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      quickSetupBatchId:
                        type: string
                      slotsNeeded:
                        type: integer
                      invoiceUrl:
                        type: string
                    required:
                      - quickSetupBatchId
                      - slotsNeeded
                      - invoiceUrl
                    x-apidog-orders:
                      - quickSetupBatchId
                      - slotsNeeded
                      - invoiceUrl
                required:
                  - status
                  - message
                  - data
                x-apidog-orders:
                  - status
                  - message
                  - data
              example:
                status: 200
                message: Quick setup initiated
                data:
                  quickSetupBatchId: 550e8400-e29b-41d4-a716-446655440000
                  slotsNeeded: 3
                  invoiceUrl: https://invoice.stripe.com/i/acct_xxx/...
          headers: {}
          x-apidog-name: Success
        '400':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  message:
                    type: string
                  errorId:
                    type: string
                required:
                  - status
                  - message
                  - errorId
                x-apidog-orders:
                  - status
                  - message
                  - errorId
              example:
                status: 400
                message: Domain "example.com" has no mailboxes defined
                errorId: 550e8400-e29b-41d4-a716-446655440000
          headers: {}
          x-apidog-name: Bad Request
      security: []
      x-apidog-folder: quick setup
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797058/apis/api-33476112-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.zapmail.ai/api
    description: Prod Env
security: []

```