Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer token via Authorization header

Headers

idempotency-key
string

Idempotency-Key: 1-255 printable ASCII characters. Same key with a different request body is a 422 idempotency_key_reused. A retryable in-flight duplicate is a 409 with Retry-After and x-should-retry: true; a terminal duplicate is a 409 with x-should-retry: false. A replay returns the current resource state with Idempotent-Replayed: true.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]{1,255}$
Example:

"b3f6a9f0-6f1a-4e9a-9e7a-9c9b6b6a5a3f"

Body

application/json
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

Archived mailbox returned (idempotent replay)

data
object
required