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>

Funding preference. Omit or use included for included-first activation; rent always preserves package capacity and starts paid checkout.

Available options:
included,
rent
label
string
Maximum string length: 100
localPart
string

Optional full mailbox local part (the address before "@"). Trimmed and lowercased before validation. Omit for a random, non-guessable mx_-prefixed 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