Update an organization relationship
Identity module
PATCH/organization-relationships/{id}organizationRelationships.update
One organization's relationship to another, with the org-owned facts. Never visible to another org. 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 vendors.vendor.write.
- OAuth scopes: vendors.
- 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 organization relationship. |
Request body: OrganizationRelationshipUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| counterparty_type | CounterpartyType | null | No |
{}Response 200: OrganizationRelationship
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the organization relationship. |
| 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. |
| organization_id | string (uuid) | Yes | Identifier of the related organization. |
| counterparty_type | CounterpartyType | null | Yes |
{
"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",
"organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"counterparty_type": "AV Integrator"
}Code samples
curl -X PATCH "$XOS_BASE_URL/organization-relationships/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 '{}'const { data, etag } = await xos.organizationRelationships.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {}, { ifMatch: etag });response = xos.organization_relationships.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {}, if_match=etag)xos organization-relationships update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{}' --if-match auto