schedule mailbox creation

Testing

POST

/v2/mailboxes/schedule

Schedule mailbox creation for single or bulk mailboxes. Mailboxes are scheduled to be created on the next subscription renewal date. Supports bulk scheduling by passing multiple domains with multiple mailboxes in the payload.

Request

Header Params

Body Params application/jsonRequired

Example

{
    "<domainId1>": [
      { "domainName": "example1.com", "mailboxUsername": "john", "firstName": "John", "lastName": "Doe" },
      { "domainName": "example1.com", "mailboxUsername": "jane", "firstName": "Jane", "lastName": "Smith" }
    ],
    "<domainId2>": [
      { "domainName": "example2.com", "mailboxUsername": "bob", "firstName": "Bob", "lastName": "Wilson" }
    ]
  }

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/mailboxes/schedule' \
--header 'x-auth-zapmail: YOUR_API_KEY' \
--header 'x-service-provider: GOOGLE' \
--header 'Content-Type: application/json' \
--data-raw '{
    "<domainId1>": [
      { "domainName": "example1.com", "mailboxUsername": "john", "firstName": "John", "lastName": "Doe" },
      { "domainName": "example1.com", "mailboxUsername": "jane", "firstName": "Jane", "lastName": "Smith" }
    ],
    "<domainId2>": [
      { "domainName": "example2.com", "mailboxUsername": "bob", "firstName": "Bob", "lastName": "Wilson" }
    ]
  }'

Responses

🟢200Success

application/json

Body

Example

{
    "status": 200,
    "message": "Mailboxes scheduled for creation",
    "data": [
        {
            "id": "...",
            "userId": "...",
            "workspaceId": "...",
            "domainId": "...",
            "status": "PENDING",
            "creationTime": "2024-02-01T00:00:00.000Z"
        }
    ]
}

🟠400Bad Request

Modified at 2026-01-15 00:00:20

Custom OAuth

retry creation of failed mailboxes