Update a vendor class

Vendors module

PATCH/vendor-classes/{id}vendorClasses.update

An org vendor class, seeded from the Standard Library. 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.class.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

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

Request body: VendorClassUpdate

vendorClasses.update: VendorClassUpdate
Field	Type	Required	Description
name	string	No	Vendor class name.Constraints: length 1 to 300
std_vendor_class_id	string \| null	No	Standard Library vendor class adopted.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
description	string \| null	No	What the class covers.Constraints: length 1 to 20000

{
  "name": "Staging",
  "std_vendor_class_id": "VC-001",
  "description": "Staging rental houses."
}

Response 200: VendorClass

vendorClasses.update: VendorClass
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the vendor class.
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.
name	string	Yes	Vendor class name.Constraints: length 1 to 300
std_vendor_class_id	string \| null	Yes	Standard Library vendor class adopted.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
description	string \| null	Yes	What the class covers.Constraints: length 1 to 20000

{
  "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",
  "name": "Staging",
  "std_vendor_class_id": "VC-001",
  "description": "Staging rental houses."
}

Code samples

curl -X PATCH "$XOS_BASE_URL/vendor-classes/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":"Staging","std_vendor_class_id":"VC-001","description":"Staging rental houses."}'

const { data, etag } = await xos.vendorClasses.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "name": "Staging",
    "std_vendor_class_id": "VC-001",
    "description": "Staging rental houses."
  }, { ifMatch: etag });

response = xos.vendor_classes.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"name": "Staging", "std_vendor_class_id": "VC-001", "description": "Staging rental houses."}, if_match=etag)

xos vendor-classes update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"name":"Staging","std_vendor_class_id":"VC-001","description":"Staging rental houses."}' --if-match auto