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

Headers

X-Delogue-Api
string

Path Parameters

id
integer<int64>
required

Unique identifier of the color to update.

Body

name
null | string

Display name of the color. Required on a full replace and cannot be cleared.

userDefinedId
null | string

Primary customer-defined identifier for the color. Send null to clear it.

userDefinedId2
null | string

Secondary customer-defined identifier for the color. Send null to clear it.

colorReference
null | string

Reference code for the color, such as a Pantone code. Send null to clear it.

state
null | enum<string>

Lifecycle state of the color. Required on a full replace.

Available options:
active,
inactive,
deleted
colorNote
null | string

Free-text note describing the color. Send null to clear it.

colorGroupIds
null | integer<int64>[]

Color group memberships to write. A populated list replaces the set. This is a full replace, so an empty, null, or omitted list clears every membership.

languageIds
null | integer<int64>[]

Language links to write. Requires the multiple-language feature. With the feature on this is a full replace, so a populated list replaces the set and an empty, null, or omitted list clears every link. With the feature off a populated list is rejected and an empty, null, or omitted one leaves the existing links untouched.

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.