POST
/
domains
/
{domain}
/
mailboxes

Authorizations

​
X-CUSTOMER-OS-API-KEY
string
headerrequired

Path Parameters

​
domain
string
required

Domain name

Body

application/json

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

Response containing mailbox details and status

​
mailbox
object

Mailbox information required: false

​
requestId
string
​
status
string

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

List mailboxes