FreeCustom.Email APIV1Custom DomainsDomainVerify

Verify a custom domain

View as Markdown
Triggers a live DNS check for the domain's MX and TXT records. Call this after you have added the two records at your registrar. **DNS records required:** | Type | Host | Value | Priority | |------|------|-------|----------| | MX | @ | `mx.freecustom.email` | 10 | | TXT | @ | `freecustomemail-verification=<token>` | — | The `<token>` is the value returned in `txt_record` when you added the domain. It is unique per domain + account. DNS propagation can take up to 48 hours. If verification fails, wait a few minutes and retry — the response includes the specific record that is missing. Once verified, you can immediately register inboxes at `@{domain}` via `POST /v1/inboxes`. **Plan required:** Growth ($49/mo) or Enterprise ($149/mo).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

domainstringRequired

The bare domain name to verify (e.g. mail.acme.com).

Response

OK
successboolean
verifiedboolean
messagestring
dataobject

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error