Update an organization relationship

Módulo Identity

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.

Requiere la capacidad vendors.vendor.write.
Alcances de OAuth: vendors.
Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

organizationRelationships.update: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the organization relationship.

Cuerpo de la solicitud: OrganizationRelationshipUpdate

organizationRelationships.update: OrganizationRelationshipUpdate
Campo	Tipo	Obligatorio	Descripción
counterparty_type	CounterpartyType \| null	No

{}

Respuesta 200: OrganizationRelationship

organizationRelationships.update: OrganizationRelationship
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the organization relationship.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
organization_id	string (uuid)	Sí	Identifier of the related organization.
counterparty_type	CounterpartyType \| null	Sí

{
  "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"
}

Ejemplos de código

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