Assign Mailboxes to Domain

POST

/v1/mailboxes/assign

Assign one or more mailboxes to domains. Each mailbox must specify a domain and either mailboxUsername or legacy userName. Returns created mailbox records. Either mailboxUsername or legacy userName is accepted

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/jsonRequired

Example

{
    "mailboxes": [
        {
            "mailboxUsername": "john",
            "domain": "b2bforcelabs.com",
            "firstName": "John",
            "lastName": "Doe"
        },
        {
            "mailboxUsername": "jane",
            "domain": "b2bforcelabs.com",
            "firstName": "Jane",
            "lastName": "Smith"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/v1/mailboxes/assign' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "mailboxes": [
        {
            "mailboxUsername": "john",
            "domain": "b2bforcelabs.com",
            "firstName": "John",
            "lastName": "Doe"
        },
        {
            "mailboxUsername": "jane",
            "domain": "b2bforcelabs.com",
            "firstName": "Jane",
            "lastName": "Smith"
        }
    ]
}'

Responses

🟢201

application/json

Mailboxes assigned successfully

Bodyapplication/json

Example

{
    "status": 201,
    "message": "Mailboxes assigned successfully.",
    "data": {
        "created": 2,
        "mailboxes": [
            {
                "id": "mb_abc1",
                "username": "john",
                "fullName": "John Doe",
                "status": "PENDING",
                "domainId": "cmg9l788c0001la04ctg7t1j4"
            },
            {
                "id": "mb_abc2",
                "username": "jane",
                "fullName": "Jane Smith",
                "status": "PENDING",
                "domainId": "cmg9l788c0001la04ctg7t1j4"
            }
        ]
    }
}

🟠400

🟠401

🔴500

Delete Tag

List Placement Tests