Skip to main content
POST
email.domain.setuplink.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

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 set up at your DNS host, e.g. example.com.

Response

The result

supported
boolean
required

Whether your DNS host offers a setup page for these records. false: publish the records from email.domain.get by hand.

providerName
string

The DNS provider the setup page belongs to.

url
string

The setup page's address, when supported.

width
number

Suggested popup width for the page.

height
number

Suggested popup height for the page.

state
string

Opaque state to pass back when the page reports its result.

conflictingProvider
string

A mail provider already holding conflicting records on the domain, when found.