Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

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

Body

application/json

Both fields are optional. Omitting username generates one; omitting domain_id uses the account's shared inbound subdomain. Omitting both creates an instant inbox with a generated username.

username
string

Inbox local part. Trimmed and lowercased before validation; the normalized value must be 1-64 characters, start and end with a letter or digit, and contain only letters, digits, dots, hyphens, and underscores. Generated when omitted.

domain_id
string<uuid>

Account-owned, inbound-enabled domain UUID. The account's shared inbound subdomain is allocated when omitted.

Response

Email inbox created.

data
object
required