Update an organization

Identity module

PATCH/organizations/{id}organizations.update

Every company on the platform: a tenant (with a subscription), an external account, or both. A partner org cannot have a parent partner. 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.general.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

organizations.update: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the organization.

Request body: OrganizationUpdate

organizations.update: OrganizationUpdate
Field	Type	Required	Description
name	string	No	Trade name.Constraints: length 1 to 300
slug	string	No	URL slug.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
parent_org_id	string (uuid) \| null	No	Identifier of the partner organization.
organization_type	string	No	Legal form from `xpms.organization_type` (decision D17): For-Profit, Nonprofit or Public Agency. It decides which worker classifications engagements may use.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]( [A-Za-z0-9&'/.()-]+)$

{
  "name": "Northwind Live",
  "slug": "northwind-live",
  "parent_org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "organization_type": "For-Profit"
}

Response 200: Organization

organizations.update: Organization
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the organization.
created_at	string (date-time)	Yes	When the row was created.
updated_at	string (date-time)	Yes	When the row was last updated.
name	string	Yes	Trade name.Constraints: length 1 to 300
slug	string	Yes	URL slug.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
parent_org_id	string (uuid) \| null	Yes	Identifier of the partner organization.
organization_type	string	Yes	Legal form from `xpms.organization_type` (decision D17): For-Profit, Nonprofit or Public Agency. It decides which worker classifications engagements may use.Constraints: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]( [A-Za-z0-9&'/.()-]+)$

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "updated_at": "2026-10-08T14:30:00Z",
  "name": "Northwind Live",
  "slug": "northwind-live",
  "parent_org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "organization_type": "For-Profit"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/organizations/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 '{"name":"Northwind Live","slug":"northwind-live","parent_org_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","organization_type":"For-Profit"}'

const { data, etag } = await xos.organizations.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "name": "Northwind Live",
    "slug": "northwind-live",
    "parent_org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "organization_type": "For-Profit"
  }, { ifMatch: etag });

response = xos.organizations.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"name": "Northwind Live", "slug": "northwind-live", "parent_org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "organization_type": "For-Profit"}, if_match=etag)

xos organizations update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"name":"Northwind Live","slug":"northwind-live","parent_org_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","organization_type":"For-Profit"}' --if-match auto