v4

OpenAPI 3.0.0MIT2026-07-311494532.1 MB

Domains

Create a domain

Registers a new inbound-email domain. The response includes the DNS records customers must add at their DNS provider before the domain can receive mail.

post/v1/domains

Headers

idempotency-keystring

A header for idempotency purposes

Request body

namestring required

The domain name (e.g. "recent.dev")

dataobject

Optional string key-value metadata (max 10 keys, 500 characters total for keys+values).

Response

Created

_idstring required

namestring required

status'pending' | 'verified' required

mxRecordConfiguredboolean required

dnsProviderstring

_environmentIdstring required

_organizationIdstring required

createdAtstring required

updatedAtstring required

dataobject

String key-value metadata (max 10 keys, 500 characters total when set via API).

Example response

{
  "expectedDnsRecords": [
    {
      "type": "MX",
      "name": "inbound",
      "content": "inbound-smtp.us-east-1.amazonaws.com",
      "ttl": "Auto",
      "priority": 10
    }
  ]
}