Skip to content
XOS Developers

verifiedDomains

Identity module · 6 operations

List verified domain rows

GET/verified-domains

A verified email domain with automatic join and a default role. Returns a cursor page of verified domain rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create a verified domain

POST/verified-domains

A verified email domain with automatic join and a default role. Creates a verified domain. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Get a verified domain

GET/verified-domains/{id}

A verified email domain with automatic join and a default role. Returns one verified domain with its `ETag`. A verified domain the caller may not see returns 404.

Update a verified domain

PATCH/verified-domains/{id}

A verified email domain with automatic join and a default role. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Delete a verified domain

DELETE/verified-domains/{id}

A verified email domain with automatic join and a default role. Soft-deletes the verified domain: it moves to Trash and can be restored for its table's retention period.

Check a custom domain again

POST/verified-domains/{id}/check

Queues the provider worker for a custom Atlas, Gateway or sending domain (app.request_domain_check): provisioning again when it never reached the provider, otherwise checking DNS verification and TLS now. Verified domains answer 422 (domain_not_provisioned). Returns the domain. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.