Skip to main content
When to use this. Color groups are a Professional-license feature that let you bucket your colours into broad searchable categories — Blues, Reds, Neutrals — so that e-commerce platforms and downstream systems can expose a simplified color filter to end customers. You must create the groups here before you can assign individual colours to them in POST /api/colors. Color groups are visible under Admin > Colors > Color Groups in the Delogue UI.

​
The workflow

1

Create the color groups

POST /api/color-groups with one or more groups in a single all-or-nothing request. The call returns a 409 Conflict if any name or userDefinedId already exists, even within the same request batch.
2

Assign colours to the groups

POST /api/colors (or PUT /api/colors/{id}) — pass colorGroupIds containing the ids returned above to file colours under their groups.
3

List and filter groups

GET /api/color-groups/filter to search by name, state, or user-defined ID with page-based pagination, or GET /api/color-groups/cursor for cursor-based pagination suited to infinite-scroll UIs.
4

Update or retire groups

PUT /api/color-groups/{id} to rename a group or change its state to inactive. DELETE /api/color-groups/{id} permanently removes a group — only possible when no colours are still assigned to it (returns 409 otherwise).

​
Walkthrough

Create two colour groups in a single request. The body is an array — all items are created atomically or none at all.
The response wraps the created groups in the standard envelope. Hold onto each id — you pass it as a colorGroupIds entry when creating or updating individual colours.

​
Field reference

A color group can only be deleted when no colours are assigned to it. If colours are still linked, DELETE /api/color-groups/{id} returns 409 Conflict. Reassign or remove those colours first, then retry the delete.

​
Roles & permissions

Managing color groups requires the colors permission on a designer (brand) account — typically CompanyAdmin or a user with the Color Admin role. Supplier accounts collaborate on styles but do not manage a brand’s colour library or its groups. The color group feature is only available on the Professional license.

​
When things go wrong

Errors use the standard envelope (status: "error", a code, and error.details[]). See Errors & responses for the full list of codes and how to resolve them. Common scenarios:

​
What to call next

Colours

Create individual colours and file them under these groups using colorGroupIds.

Seasons

Seasons are another top-level admin entity you set up before creating styles.

Size ranges

Define the size ranges your colours are offered in.

Color Groups API reference

Full endpoint reference for GET, POST, PUT, and DELETE on /api/color-groups.