Skip to main content
POST
Creates multiple colors in a single transaction.

Headers

X-Delogue-Api
string

Body

name
null | string

Display name of the color. Required.

userDefinedId
null | string

Primary customer-defined identifier for the color.

userDefinedId2
null | string

Secondary customer-defined identifier for the color.

colorReference
null | string

Reference code for the color, such as a Pantone code.

colorNote
null | string

Free-text note describing the color.

state
enum<string>

Initial lifecycle state of the color. Defaults to active when omitted.

Available options:
active,
inactive,
deleted
colorGroupIds
null | integer<int64>[]

Identifiers of the color groups to link the new color to.

languageIds
null | integer<int64>[]

Identifiers of the languages to link the color to. The translated name per language is managed through a separate endpoint.

Response

Created

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.