Email Domains

The email_domain object

A domain registered with the email bridge for sending and receiving mail.

After registration the domain starts in pending; publish the returned DKIM records, then poll the verify action until it flips to verified.

idstring

Email domain ID.

objectstringenumValues:email_domain

Resource type identifier.

domainstring

The fully-qualified domain name (e.g. support.acme.com).

statusstringenumValues:pendingverifiedfailed

Verification status.

pending: registered and awaiting DKIM confirmation.
verified: DKIM confirmed; the domain can send mail.
failed: verification could not be completed.

Inboxes can only be created on a verified domain.

dkim_tokensarray of string

The DKIM tokens that must be published in your DNS before the domain can be verified.

Publish each token as a CNAME record on the domain, then call the verify action to confirm them.

mail_from_domainstringnullable

The subdomain used as the envelope return path for mail sent from this domain.

Publishing the two records below makes the return path match the sender address. Until you do, mail clients show your mail as coming from your address "via amazonses.com".

mail_from_mx_recordstringnullable

The MX record to publish on mail_from_domain, for delivery of bounces and complaints.

mail_from_spf_recordstringnullable

The SPF record to publish as a TXT record on mail_from_domain.

verified_atstring (date-time)nullable

When the domain's DKIM verification was confirmed.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Used by

POSTCreate Email DomainEmail Domains GETList Email DomainsEmail Domains GETGet Email DomainEmail Domains DELETEDelete Email DomainEmail Domains POSTVerify Email DomainEmail Domains POSTCreate Email InboxEmail Inboxes PATCHUpdate Email InboxEmail Inboxes GETList Email InboxesEmail Inboxes GETGet Email InboxEmail Inboxes

email_domain example

{
  "id": "emdom_2rk3omr8vshb",
  "object": "email_domain",
  "domain": "support.acme.com",
  "status": "pending",
  "dkim_tokens": [
    "abc123._domainkey.support.acme.com",
    "def456._domainkey.support.acme.com"
  ],
  "mail_from_domain": null,
  "mail_from_mx_record": null,
  "mail_from_spf_record": null,
  "verified_at": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "emdom_2rk3omr8vshb",
  "object": "email_domain",
  "domain": "support.acme.com",
  "status": "pending",
  "dkim_tokens": [
    "abc123._domainkey.support.acme.com",
    "def456._domainkey.support.acme.com"
  ],
  "mail_from_domain": null,
  "mail_from_mx_record": null,
  "mail_from_spf_record": null,
  "verified_at": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Email Domains

Attributes

Used by