Skip to main content
PUT
Updates a single color group by ID.

Headers

X-Delogue-Api
string

Path Parameters

id
integer<int64>
required

The unique identifier of the color group to update.

Body

id
integer<int64>

The unique identifier of the color group to update. The value in the route path takes precedence over any id sent in the body.

name
null | string

The new display name for the color group. This field is required.

userDefinedId
null | string

An optional customer-defined identifier for the color group. Send null to clear any existing value.

state
null | enum<string>

The state to set on the color group. Omit this field to leave the current state unchanged.

Available options:
active,
inactive

Response

OK

status
enum<string>
required

The coarse outcome of the request, indicating whether it succeeded or failed.

Available options:
success,
error
code
string
required

The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire.

data
null | object
required

The response payload, either a single object for a by-id read or an array for a bulk operation. Omitted from the body when there is no value.