Assign New Mailboxes to Domains

This endpoint allows you to assign new mailboxes to specific domains.

Validation Rules

Payload Structure

The root object must have domain IDs as keys.

Each value must be an array of mailbox objects.

Arrays cannot be empty.

Mailbox Object Validation

Each mailbox object must include firstName, lastName, mailboxUsername, and domainName.

mailboxUsername must:

Not start or end with ., _, or -.

Not contain consecutive ., _, or -.

firstName, lastName, and domainName must be strings.

Microsoft Service Provider Rule

For users with Microsoft, mailboxes cannot be assigned if previously assigned mailboxes are not yet active.

Subscription and Quota Checks

Users must have purchased mailboxes available for assignment.

The total mailboxes being assigned cannot exceed the remaining mailbox quota.

Scheduled and "immedidate delete" mailboxes in a subscription is deducted from the quota.

24-Hour Domain Rule

Mailboxes cannot be assigned to domains where mailboxes were already created within the last 24 hours.

Per-Domain Assignment Limit

Total mailboxes assigned to a single domain cannot exceed 5

Request

Header Params

Body Params application/json

Example

{
    "64e71b99-bc07-4b5d-90b6-6abc0120c08c": [
        {
            "firstName": "Jaspreet",
            "lastName": "Singh",
            "mailboxUsername": "jaspreet",
            "domainName": "azhaz.com"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Assign New Mailboxes to Domains

Validation Rules#

Request

Request Code Samples

Responses

Validation Rules