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.

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 DomainsGETList Email DomainsEmail DomainsGETGet Email DomainEmail DomainsDELETEDelete Email DomainEmail DomainsPOSTVerify Email DomainEmail DomainsPOSTCreate Email InboxEmail InboxesPATCHUpdate Email InboxEmail InboxesGETList Email InboxesEmail InboxesGETGet Email InboxEmail Inboxes