Assign New Mailbox to Domain

POST

/v1/mailboxes

Create and assign a new mailbox under a domain owned by the user.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

Body Params application/json

Example

{
  "mailboxes": [
    {
      "userName": "support",
      "firstName": "Support",
      "lastName": "Team",
      "domain": "example.com",
      "workspaceType": "Google Standard"
    },
    {
      "userName": "sales",
      "firstName": "Sales",
      "lastName": "Department",
      "domain": "example.com",
      "workspaceType": "Google Premium"
    }
  ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/v1/mailboxes' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "mailboxes": [
    {
      "userName": "support",
      "firstName": "Support",
      "lastName": "Team",
      "domain": "example.com",
      "workspaceType": "Google Standard"
    },
    {
      "userName": "sales",
      "firstName": "Sales",
      "lastName": "Department",
      "domain": "example.com",
      "workspaceType": "Google Premium"
    }
  ]
}'

Responses

🟢201Created

application/json

Mailbox created successfully

Body

Example

{
    "id": "cmg9l78m8000bla04a6onx0ih",
    "username": "Mary",
    "fullName": "Mary",
    "status": "PENDING",
    "createdAt": "2025-10-02T15:45:32.768Z"
}

🟠400Bad Request

🟠401Unauthorized

Retrieve Mailboxes

Get Mailbox Details