Domains

Register a domain for verification.

Requires manage scope. Gated by the plan's verified_domain_limit (cap_reached, 403, body carries used/limit). domain is validated as a bare hostname (invalid_domain, 400); a domain already claimed by any inboxy account is rejected as a conflict (already_claimed, 409 — a deliberate divergence from most other create endpoints' single 400 reason, since this is a conflict with existing state rather than a malformed request). The response's dns_records are the TXT/SPF/DKIM records to publish; verification runs on a periodic sweep or on-demand via POST /v1/domains/{id}/verify. Verification only — a verified domain cannot yet be used to send mail.

post/v1/domains

Request

  • Base URL: https://api.inboxy.net
  • URL: https://api.inboxy.net/v1/domains
  • Auth: HTTP bearer

Request body

domainstring required

Bare hostname, e.g. mail.example.com. No scheme, path, port, or IP literal.

Response

Created, in pending status.

idstring uuid required
domainstring required
status'pending' | 'verified' | 'verification_lost' required

verified after 3 consecutive passing checks; demoted to verification_lost after 2 consecutive failures once verified. Verification only — this status never grants a sending capability.

txt_okboolean required

Ownership TXT challenge record found and matching.

spf_state'ok' | 'conflict' | 'missing' | 'null' nullable required
spf_suggestionstring nullable required

Suggested SPF record text. Null iff spf_state is ok.

dkim_cname_okboolean required

DKIM selector CNAME found and matching.

last_checked_atinteger nullable required

Unix seconds.

created_atinteger required

Unix seconds.

verified_atinteger nullable required

Unix seconds of the transition into verified. A re-check that keeps the domain verified, or one that fails without demoting it, never clears this. It IS cleared back to null if the domain is demoted to pending (e.g. by rotating its verify token) — it re-marks the transition on the next fresh verification.

Changes

No recorded changes to this operation across all 1 revision of this API.