Skip to main content
POST
Provision a dedicated subdomain

Authorizations

Authorization
string
header
required

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

Body

application/json
label
string
required
Pattern: ^[a-z0-9-]+$
Example:

"acme"

Response

Created

id
string<uuid>
hostname
string
Example:

"mail.yourcompany.com"

kind
enum<string>
Available options:
system,
tenant_subdomain,
byo
status
enum<string>
Available options:
pending,
verifying,
verified,
failed
mail_from_domain
string | null
mail_from_status
enum<string> | null
Available options:
pending,
success,
failed
dmarc_policy
enum<string>
Available options:
none,
quarantine,
reject
verified_at
string<date-time> | null
created_at
string<date-time>
records
object[]