Skip to main content
POST
Create Mailbox

Authorizations

Authorization
string
header
required

Public API bearer credential sent as Authorization: Bearer <token>. Use either an OAuth access token or a Hybridbox Service account token.

Path Parameters

account_id
string<uuid>
required

Body

application/json

Request body for creating a mailbox.

domain
string
required

Domain UUID or domain name for the mailbox

first_name
string
required
last_name
string
required
local_part
string
required

Response

created_at
string
required

Mailbox creation timestamp

domain_id
string<uuid>
required

Domain UUID for the mailbox

domain_name
string
required

Domain name for the mailbox

first_name
string
required

Mailbox user first name

id
string<uuid>
required

Mailbox UUID

last_name
string
required

Mailbox user last name

local_part
string
required

Mailbox local part before the at sign

primary_email
string
required

Primary mailbox email address

quota
MailboxQuotaDTO · object
required

Mailbox quota usage

status
string
required

Mailbox lifecycle status

updated_at
string
required

Mailbox last update timestamp

aliases
MailboxAliasDTO · object[]

Aliases for the mailbox

workspace_id
string<uuid> | null

Workspace UUID for the mailbox

workspace_name
string | null

Workspace display name