POST
/
domains
/
{domain}
/
mailboxes
Create mailbox
curl --request POST \
  --url https://api.customeros.ai/domains/{domain}/mailboxes \
  --header 'Content-Type: application/json' \
  --header 'X-CUSTOMER-OS-API-KEY: <api-key>' \
  --data '{
  "forwardingTo": [
    "<string>"
  ],
  "linkedUser": "<string>",
  "password": "<string>",
  "username": "<string>",
  "webmailEnabled": true
}'
{
  "mailbox": {
    "email": "<string>",
    "forwardingEnabled": true,
    "forwardingTo": [
      "<string>"
    ],
    "password": "<string>",
    "webmailEnabled": true
  },
  "requestId": "1234567890abcdef",
  "status": "success"
}

Authorizations

​
X-CUSTOMER-OS-API-KEY
string
header
required

Path Parameters

​
domain
string
required

Domain name

Body

application/json

Mailbox configuration

Request payload for creating and configuring a new mailbox

Response

200
application/json

Mailbox created successfully with generated password

Response containing mailbox details and status