Update a verified domain
Identity module
PATCH/verified-domains/{id}verifiedDomains.update
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.
- Requires the capability org.security.write.
- OAuth scopes: org.
- Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
- Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the verified domain. |
Request body: VerifiedDomainUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| auto_join_role_id | string (uuid) | null | No | Identifier of the role a person with a confirmed address at this verified domain receives on joining automatically; null turns automatic join off. |
{
"auto_join_role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Response 200: VerifiedDomain
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the verified domain. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| hostname | string | Yes | Lowercase host name, for example gateway.northwindlive.example.Constraints: length 1 to 253 |
| purpose | "Atlas" | "Gateway" | "Email Sending" | "Verified Domain" | Yes | What the domain is for. |
| verification_state | "Pending" | "Verified" | "Failed" | Yes | DNS verification state; changed only by app.record_domain_verification. |
| verification_token | string | Yes | Value the org publishes in a DNS TXT record to prove control.Constraints: length 1 to 300 |
| last_checked_at | string (date-time) | null | Yes | When the verification service last checked DNS. |
| auto_join_role_id | string (uuid) | null | Yes | Identifier of the role a person with a confirmed address at this verified domain receives on joining automatically; null turns automatic join off. |
| provisioning_status | "Not Started" | "Requested" | "Pending DNS" | "Active" | "Failed" | "Released" | Yes | Where the domain stands at its provider. |
| dns_records | array of DomainDnsRecord | Yes | DNS records to publish for the provider. |
| tls_ready | boolean | Yes | True once the provider issued the TLS certificate. |
| provisioning_error | string | null | Yes | Why the latest provisioning step failed.Constraints: length 1 to 2000 |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"hostname": "gateway.northwindlive.example",
"purpose": "Atlas",
"verification_state": "Pending",
"verification_token": "xos-verify=6f1c2d",
"last_checked_at": "2026-10-08T14:30:00Z",
"auto_join_role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"provisioning_status": "Pending DNS",
"dns_records": [
{
"type": "CNAME",
"name": "atlas.northwindlive.example",
"value": "cname.vercel-dns.com",
"purpose": "routing"
}
],
"tls_ready": false,
"provisioning_error": "Vercel returned 400"
}Code samples
curl -X PATCH "$XOS_BASE_URL/verified-domains/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H 'If-Match: W/"etag-from-your-last-read"' \
-H "Content-Type: application/json" \
-d '{"auto_join_role_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'const { data, etag } = await xos.verifiedDomains.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"auto_join_role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}, { ifMatch: etag });response = xos.verified_domains.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"auto_join_role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}, if_match=etag)xos verified-domains update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"auto_join_role_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}' --if-match auto