Skip to content
XOS Developers

Delete an organization relationship

Identity module

DELETE/organization-relationships/{id}organizationRelationships.delete

One organization's relationship to another, with the org-owned facts. Never visible to another org. Soft-deletes the organization relationship: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability vendors.vendor.write.
  • OAuth scopes: vendors.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

organizationRelationships.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the organization relationship.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/organization-relationships/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.organizationRelationships.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.organization_relationships.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos organization-relationships delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f