carriers5

channels5

clusters5

customer-addresses3

customers4

delivery-modalities5

delivery-types5

freight-types5

fulfillment-order-shipment-tracking-events1

fulfillment-order-shipments3

fulfillment-order-tracking-events1

fulfillment-orders4

inventory2

inventory-movements1

operators5

order-payments2

orders7

payment-methods3

permissions1

price-lists7

product-categories5

products3

promotions5

state-machines6

statuses5

strategies5

strategy-carriers5

strategy-channels5

strategy-operators5

strategy-price-lists5

webhook-subscriptions6

clusters

Update cluster

Changed on Jul 7, 2026

Partially updates a cluster by its identifier. The code is immutable.

patch/api/v1/clusters/{id}

Request

Base URL
https://oms-api.tenant.krzlabs.io
Auth
- HTTP basic
- or HTTP bearer
TypeScript
https://skmtc.dev/kruzer-corp/apis/oms-api/docs/api/v1/clusters/:id/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

Example:01920000-0000-7000-8000-000000000000

Cluster identifier (UUID).

Request body

namestring

activeboolean

descriptionstring nullable

colorstring nullable

metadataobject nullable

Response

Cluster updated.

idstring required

codestring required

namestring required

descriptionstring nullable required

colorstring nullable required

activeboolean required

metadataobject nullable required

created_atstring required

updated_atstring required

Changes

Jul 7, 2026a3b4750a505f Revision changes
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
Jul 7, 202684194c31ab85 Revision changes
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property

Operation history