Create Email Domain
BetaPOST
/v1/messaging/email-domainsIdempotent 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.
domainstringThe fully-qualified domain name to register (e.g. support.acme.com).
idstringEmail domain ID.
objectstringenumValues:email_domainResource type identifier.
domainstringThe fully-qualified domain name (e.g. support.acme.com).
statusstringVerification 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 stringThe DKIM CNAME tokens the customer must publish in DNS to verify the domain.
verified_atstring (date-time)nullableWhen 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