POST
/
domains
/
{domain}
/
mailboxes
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

​
forwardingTo
string[]

List of email addresses to forward to required: false maxItems: 10 example: ["user1@example.com","user2@example.com"]

​
linkedUser
string

Associated user's email address required: false format: email example: john.doe@mycompany.com

​
password
string

Password for mailbox access required: false minLength: 8 maxLength: 64 example: SecurePassword123!

​
username
string

Username for the mailbox required: true pattern: ^[a-zA-Z0-9._%+-]+$ minLength: 3 maxLength: 64 example: john.doe

​
webmailEnabled
boolean

Enable webmail access required: false default: false

Response

200
application/json
Mailbox created successfully with generated password

Response containing mailbox details and status

​
mailbox
object

Mailbox information required: false

​
requestId
string
Example:

"1234567890abcdef"

​
status
string

Status indicates the result of the operation ("success" or "error")

Example:

"success"

List mailboxes