Sign in
Mailboxes

Create mailbox

Creates a new mailbox for the specified domain with optional forwarding and webmail access

post/domains/{domain}/mailboxes

Path parameters

domainstring required

Domain name

Request body

forwardingTostring[]

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

linkedUserstring

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

passwordstring

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

usernamestring

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

webmailEnabledboolean

Enable webmail access required: false default: false

Response

Mailbox created successfully with generated password

requestIdstring
statusstring

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

Example response

{
  "requestId": "1234567890abcdef",
  "status": "success"
}

Changes

Changed in 2 of the 23 revisions of this API.11