For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • FreeCustom.Email API
        • GETList your custom domains
        • POSTAdd a custom domain
          • DELRemove a custom domain
            • POSTVerify a custom domain
LogoLogo
FreeCustom.Email APIV1Custom DomainsDomainVerify

Verify a custom domain

||View as Markdown|
POST
https://api2.freecustom.email/v1/custom-domains/:domain/verify
POST
/v1/custom-domains/:domain/verify
$curl -X POST https://api2.freecustom.email/v1/custom-domains/%7B%7BcustomDomain%7D%7D/verify \
>     -H "Authorization: Bearer <token>"
1{
2  "success": true,
3  "verified": true,
4  "message": "Domain \"mail.acme.com\" verified successfully. You can now register inboxes at @mail.acme.com.",
5  "data": {
6    "domain": "mail.acme.com",
7    "verified": true,
8    "mx_record": "mx.freecustom.email",
9    "txt_record": "freecustomemail-verification=a1b2c3d4e5f6..."
10  }
11}
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).
Was this page helpful?
Previous

Remove a custom domain

Next

List inboxes

Built with

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:

TypeHostValuePriority
MX@mx.freecustom.email10
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)orEnterprise(49/mo) or Enterprise (49/mo)orEnterprise(149/mo).

Authentication

AuthorizationBearer

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

Path parameters

domainstringRequired

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