Skip to main content
POST
email.domain.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
domain
string
required

The domain to add, e.g. example.com.

inbound
boolean
default:true

Receive mail for this domain (default). false keeps your current mail receiver.

subdomains
boolean
default:false

Also allow inboxes on subdomains of the domain. Default false.

Response

The result

domain
string
required

The domain name, e.g. example.com.

status
enum<string>
required

Whether the DNS checks have passed yet.

Available options:
pending,
verified,
failed
dnsRecords
object[]
required

DNS records to publish at your DNS host.

reason
string

Why the domain is not verified yet, when known.

ref
string

Reference to what this call created. Pass it as ref to email.domain.get.