Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer token via Authorization header

Body

application/json
clientRequestId
string
required
Required string length: 1 - 128
billingPreference
enum<string>

included uses package capacity when available and otherwise starts paid checkout; included_only fails without creating a paid reservation when no included slot remains; rent always starts paid checkout.

Available options:
included,
included_only,
rent
domainId
string<uuid>

Optional active custom mailbox domain owned by the caller. Omit to use the system domain.

label
string
Maximum string length: 100
localPart
string

Optional mailbox name before the "@". Omit to generate a random address.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9](?:[A-Za-z0-9._-]{0,62}[A-Za-z0-9])?$
Example:

"jane-doe"

Response

Existing mailbox returned (idempotent replay)

data
object
required