Skip to main content
PATCH
Manage Domain

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

domain_id
string
required

The ID of the domain.

Body

application/json

Provide at least one of feedback_enabled, inbound_enabled, subdomains_enabled, or tracking_enabled. Omitted fields are left unchanged; an empty body is rejected. Enabling inbound_enabled or subdomains_enabled on a verified domain returns it to PENDING until the newly required MX record (the apex MX, or the wildcard *.<domain>) is published and verified.

feedback_enabled
boolean

Bounce and complaint notifications are sent to your inboxes.

inbound_enabled
boolean

Receive email for this domain. Defaults to true. Set false for a send-only domain: the apex MX record is not required and is omitted from records, so the domain's existing email provider keeps receiving its mail. Inboxes on a send-only domain can still send.

subdomains_enabled
boolean

Allow inboxes on any subdomain of this domain. Adds a required wildcard MX record (*.<domain>) to records.

tracking_enabled
boolean

Serve open tracking pixels from this domain. Adds a required link.<domain> CNAME record to records, which must be published and verified before track_opens can be used on a send.

Response

Response with status 200

domain_id
string
required

The ID of the domain.

domain
string
required

The name of the domain (e.g., example.com).

status
enum<string>
required

The verification status of the domain.

Available options:
NOT_STARTED,
PENDING,
INVALID,
FAILED,
VERIFYING,
VERIFIED
feedback_enabled
boolean
required

Bounce and complaint notifications are sent to your inboxes.

subdomains_enabled
boolean
required

Allow inboxes on any subdomain of this domain. Adds a required wildcard MX record (*.<domain>) to records.

tracking_enabled
boolean
required

Serve open tracking pixels from this domain. Adds a required link.<domain> CNAME record to records, which must be published and verified before track_opens can be used on a send.

records
VerificationRecord · object[]
required

A list of DNS records required to verify the domain. Includes the apex MX record unless inbound_enabled is false, and a wildcard MX record (*.<domain>) when subdomains_enabled is true.

updated_at
string<date-time>
required

Time at which the domain was last updated.

created_at
string<date-time>
required

Time at which the domain was created.

pod_id
string

ID of pod.

reason
string

Why the domain is not (yet) VERIFIED, when known. dns_records_missing / dns_records_invalid point at the DNS records. The ses_* values mean the records look right and sending-infrastructure validation has not converged: ses_dkim_pending / ses_mail_from_pending (still checking), ses_dkim_temporary_failure / ses_mail_from_temporary_failure (a transient error the infrastructure keeps retrying on its own — usually resolves without changes), ses_dkim_failed / ses_mail_from_failed (a terminal verdict; re-verify after fixing), ses_dkim_not_started / ses_mail_from_not_started (the attribute was never configured on the identity — re-verify to push it), and ses_not_verified_for_sending. Absent when VERIFIED.

inbound_enabled
boolean

Absent on domains created before this field existed; those receive email.

client_id
string

Client ID of domain.