Create Email Domain

Beta
POST/v1/messaging/email-domains

Idempotent with Idempotency-Key header. Learn more

Registers a customer-owned domain with the email bridge and returns the DKIM records to publish.

The domain starts in pending until verified.

Permissions requiredValues:messaging:create
The role behind your API key or agent must grant every one of these permissions.
domainstring

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

idstring

Email domain ID.

objectstringenumValues:email_domain

Resource type identifier.

domainstring

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

statusstring

Verification status.

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

The DKIM CNAME tokens the customer must publish in DNS to verify the 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.

Responses

201

Successful response for Create Email Domain