Skip to main content
POST
Create a hosted mailbox

Authorizations

Authorization
string
header
default:ACCESS_TOKEN
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
domainId
string
required

ID of a domain on your account.

Required string length: 20
localPart
string
required
Example:

"support"

displayName
string
Example:

"Example Support"

quotaMb
integer

Optional mailbox capacity in MB; account storage limits apply.

Response

201 - application/json

Mailbox created.

success
boolean
required
Example:

true

message
string
required
Example:

"Done"

data
any
required

Payload; shape depends on the endpoint.