Create a mailbox

POST /api/2.0/mailserver/mailboxes/add

Request

Creates a mailbox with the parameters specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

namestring

Mailbox name

local_partstring

Mailbox local part

domain_idinteger

Mailbox domain ID

user_idstring

User ID

notifyCurrentboolean

Specifies whether to notify the current user's email when a mailbox is created or not

notifyProfileboolean

Specifies whether to notify the current user's profile when a mailbox is created or not

Examples

POST /api/2.0/mailserver/mailboxes/add HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request POST \
  --url https://example.com/api/2.0/mailserver/mailboxes/add \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Mailbox data associated with the tenant

Idintegerformat: int32

UserIdstring

UserDisplayNamestring

Addressobject

Idintegerformat: int32

DomainIdintegerformat: int32

Emailstring

Namestring

Aliasesarray of object

Idintegerformat: int32

DomainIdintegerformat: int32

Emailstring

401

Unauthorized