Skip to main content
POST
Create mailbox

Authorizations

Authorization
string
header
required

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

Body

application/json

Request body schema.

domainUuid
string<uuid>
required

Domain the mailbox is created on.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
type
enum<string>
required

Mailbox flavour to provision. Decides which transport delivers from it.

Available options:
google,
outlook,
shared,
private
username
string
required

Local part of the address, e.g. jane for jane@acme.com.

Required string length: 1 - 64
firstName
string
required

Sender first name shown in the From header.

Required string length: 1 - 64
lastName
string
required

Sender last name shown in the From header.

Required string length: 1 - 64
signature
string

HTML signature stored on the mailbox. Not yet appended to outgoing messages.

Maximum string length: 10000
folderUuid
string<uuid> | null

Folder to create the mailbox in. Null means the root.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Response

Successful response

mailbox
Mailbox · object
required

Newly provisioned mailbox. It starts pending until the provider issues credentials.