Skip to main content
POST
email.domain.update

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
ref
string

The ref email.domain.create returned. Preferred over domain.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
domain
string

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

feedbackEnabled
boolean

Receive complaint feedback about mail sent from this domain.

inboundEnabled
boolean

Receive mail for this domain at your inboxes. Turning this on re-pends verification: extra DNS records are needed.

subdomainsEnabled
boolean

Allow inboxes on subdomains of this domain. Turning this on re-pends verification.

trackingEnabled
boolean

Allow open tracking for mail sent from this domain.

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.