Domains

Domain, mailbox, and webhook management is done in the dashboard, which is session-authenticated (not via an API key). This page documents what those endpoints return so you know exactly which DNS records to publish and what “verified” means. The hosting-oriented walkthrough, with registrar tips, lives on the DNS setup page.

Add a domain

Adding a domain (POST /domains) creates it in pending status and returns the DNS records to publish. A DKIM key pair is generated for the domain shortly after, adding its record to the set. An optional catch_all_target forwards mail sent to any unmatched address on the domain.

// POST /domains  →  201
{
  "domain": {
    "id": "…",
    "domain": "yourco.com",
    "status": "pending",
    "is_send_enabled": true,
    "is_receive_enabled": true,
    "verified_at": null
  },
  "dns_records": [ /* the records below */ ]
}

DNS records

Publish these at your DNS host, exactly as given. Substitute your own domain for yourco.com; the verification token and DKIM selector are unique to your domain (copy them from the dashboard).

Recommended (not required for activation) — MTA-STS and TLS-RPT enforce TLS on inbound mail to your domain and collect TLS reports:

Verify

Verification runs automatically every few minutes. To trigger an immediate re-check, call POST /domains/:id/verify (rate limited to once per 30 seconds per domain). Each record moves from pending to ok (or mismatch) as it propagates; the domain flips to active when the required records pass. A domain.verified webhook fires when it does.

You can check propagation yourself:

dig MX yourco.com +short
# expect: 10 mx1.mail.atrix.dev.

dig TXT yourco.com +short
# expect a line containing: v=spf1 include:mail.atrix.dev ~all

Health grade

GET /domains/:id/health returns the record set plus a grade summarising deliverability posture:

Endpoints