Documentation

Custom Domain Email

Host email on your own domain — DKIM, SPF, DMARC, IMAP, SMTP. Add a domain, set DNS, verify, then create accounts. Pro+ plans only.

1. Add a mail domain

curl -X POST $API/{slug}/mail/domains \
  -H "X-API-Key: $KEY" \
  -d '{"domain":"mycompany.com"}'

Response includes the DNS records you need to publish — MX, SPF, DKIM, DMARC.

2. Publish DNS records

Add the returned records at your DNS host (Cloudflare, Route53, Namecheap, whatever). Then verify:

curl -X POST $API/{slug}/mail/domains/mycompany.com/verify \
  -H "X-API-Key: $KEY"

3. Create accounts

curl -X POST $API/{slug}/mail/accounts \
  -H "X-API-Key: $KEY" \
  -d '{
    "email": "hello@mycompany.com",
    "password": "securepass",
    "display_name": "Hello"
  }'

Access the mailbox

List + stats

curl $API/{slug}/mail/accounts -H "X-API-Key: $KEY"
curl $API/{slug}/mail/stats    -H "X-API-Key: $KEY"

Endpoints

EndpointMethodDescription
/{slug}/mail/domainsGET POSTList / add mail domains
/{slug}/mail/domains/{domain}GET DELDetail / remove
/{slug}/mail/domains/{domain}/verifyPOSTVerify DNS
/{slug}/mail/domains/{domain}/dnsGETCheck DNS status
/{slug}/mail/accountsGET POSTList / create accounts
/{slug}/mail/accounts/{email}GET PATCH DELAccount CRUD
/{slug}/mail/statsGETUsage statistics