schedule mailbox creation

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

Examples

Responses

🟢200Success

application/json

Body

🟠400Bad Request

Request Example

Shell

JavaScript

Java

Swift

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" }
    ]
  }'

Response Example

200 - Success

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

Modified at 2026-04-13 04:57:43

Custom OAuth

retry creation of failed mailboxes