Skip to main content
POST
Add an email domain

Authorizations

Authorization
string
header
required

Your API key, sent bare. See Authentication.

Body

application/json
domain
string
required

The domain to send from. Use a subdomain you keep for email, such as mail.acme.com.

Maximum string length: 253
Example:

"mail.acme.com"

Response

Domain added, with the records to add.

id
string

Email domain ID, beginning with edm_. Treat it as an opaque string.

Example:

"edm_01m7a4k2r9s8x7c2dvq3m5n6p4"

object
string

Always email_domain.

domain
string

The domain summary emails are sent from, lowercase.

Example:

"mail.acme.com"

status
enum<string>

Whether the domain's records resolve.

  • pending: not all four records resolve yet. Checked every hour for 7 days, and whenever you verify it; removed if still pending after 7 days.
  • verified: all four records resolve. Checked once a day.
  • failing: was verified, but a record stopped resolving on two checks in a row. It is verified again once all four resolve.
Available options:
pending,
verified,
failing
dns_records
object[]

The four records to add at your DNS provider, three CNAMEs and an ownership TXT record.

verified_at
string<date-time> | null

When the domain last became verified, in ISO 8601. Null until then.

last_checked_at
string<date-time> | null

When the records were last checked, in ISO 8601. Null before the first check.

expires_at
string<date-time> | null

When a pending domain is removed if it isn't verified by then, in ISO 8601, 7 days after it was added. Null once the domain is verified.

created_at
string<date-time>

When the domain was added, in ISO 8601.