Add custom domain
Add a custom domain to your account. The response includes the DNS records to publish (records). Once you publish them, the domain verifies automatically within a couple of minutes — poll GET /v1/domains/{id} until status is verified, then create inboxes on it. A pod-scoped API key creates the domain scoped to its own pod; inbox-scoped keys cannot manage domains.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The domain to add, e.g. mail.acme.com. A subdomain is easiest to set up without affecting your existing mail.
4 - 253Pod to scope the domain to. Omit or null for an account-wide domain usable by any pod. A pod-scoped API key may only pass its own pod.
Response
Domain added; publish the DNS records to verify it
Domain added; publish the DNS records to verify it
OpenMail domain ID
The domain or subdomain, e.g. example.com or agent-mail.example.com.
Pod this domain is scoped to, so only inboxes in that pod can use it, or null for an account-wide domain.
pending — added, records not yet published. verifying — being checked. verified — sending and receiving enabled. failed — records missing or wrong; publishing them and calling verify again is the fix. under_review — flagged as suspicious; DNS setup is blocked until approved.
pending, verifying, verified, failed, under_review The DNS records to publish for this domain. Returned even where the values are the same for every customer, so sending infrastructure can change without breaking clients.