Error

A valid request URL is required to generate request examples

{
  "status": "success",
  "code": "<string>",
  "data": [
    {
      "styleId": 123,
      "colorId": 123,
      "name": "<string>",
      "customId1": "<string>",
      "customId2": "<string>",
      "colorReference": "<string>",
      "colorNote": "<string>",
      "state": "active",
      "colorLanguages": [
        {
          "languageId": 123,
          "languageName": "<string>",
          "languageCode": "<string>",
          "colorName": "<string>"
        }
      ],
      "colorGroups": [
        {
          "id": 123,
          "name": "<string>",
          "userDefinedId": "<string>",
          "state": "active"
        }
      ],
      "customFields": [
        {
          "id": 123,
          "customId1": "<string>",
          "type": "<string>",
          "name": "<string>",
          "value": {
            "id": 123,
            "value": "<string>",
            "customId": "<string>"
          },
          "values": [
            {
              "id": 123,
              "value": "<string>",
              "customId": "<string>"
            }
          ],
          "perColorValues": [
            {
              "styleColorId": 123,
              "value": {
                "id": 123,
                "value": "<string>",
                "customId": "<string>"
              },
              "values": [
                {
                  "id": 123,
                  "value": "<string>",
                  "customId": "<string>"
                }
              ]
            }
          ]
        }
      ],
      "properties": [
        "<string>"
      ]
    }
  ]
}

{
  "status": "success",
  "code": "<string>",
  "error": {
    "operation": "<string>",
    "total_items": 123,
    "failed_items": 123,
    "summary": "<string>",
    "details": [
      {
        "type": "<string>",
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
}

{
  "status": "success",
  "code": "<string>",
  "error": {
    "details": [
      {
        "type": "<string>",
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
}

{
  "status": "success",
  "code": "<string>",
  "error": {
    "operation": "<string>",
    "total_items": 123,
    "failed_items": 123,
    "summary": "<string>",
    "details": [
      {
        "type": "<string>",
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
}

{
  "status": "success",
  "code": "<string>",
  "error": {
    "operation": "<string>",
    "total_items": 123,
    "failed_items": 123,
    "summary": "<string>",
    "details": [
      {
        "type": "<string>",
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
}

{
  "status": "success",
  "code": "<string>",
  "error": {
    "operation": "<string>",
    "total_items": 123,
    "failed_items": 123,
    "summary": "<string>",
    "details": [
      {
        "type": "<string>",
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
}

{
  "status": "success",
  "code": "<string>",
  "error": {
    "details": [
      {
        "type": "<string>",
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
}

StyleColors

Updates the state of colors assigned to a style.

Body is always an array, even for a single item. All-or-nothing: an invalid colorId fails the whole request with no partial write. PUT is a full replace of each assignment’s state and never removes: state=“deleted” is rejected (400) — remove a color with DELETE /api/styles//colors/ (single) or DELETE /api/styles//colors?ids= (batch) so the removal cascade fires. Each returned color carries the same enriched customFields[] and properties[] (“hasCustomFieldOverrides”) as the GET routes. Capped at 200 items per request. 403 if the style belongs to another organization; 404 if a colorId isn’t assigned to the style.

PUT

api

styles

{styleId}

colors

Error

A valid request URL is required to generate request examples

{
  "status": "success",
  "code": "<string>",
  "data": [
    {
      "styleId": 123,
      "colorId": 123,
      "name": "<string>",
      "customId1": "<string>",
      "customId2": "<string>",
      "colorReference": "<string>",
      "colorNote": "<string>",
      "state": "active",
      "colorLanguages": [
        {
          "languageId": 123,
          "languageName": "<string>",
          "languageCode": "<string>",
          "colorName": "<string>"
        }
      ],
      "colorGroups": [
        {
          "id": 123,
          "name": "<string>",
          "userDefinedId": "<string>",
          "state": "active"
        }
      ],
      "customFields": [
        {
          "id": 123,
          "customId1": "<string>",
          "type": "<string>",
          "name": "<string>",
          "value": {
            "id": 123,
            "value": "<string>",
            "customId": "<string>"
          },
          "values": [
            {
              "id": 123,
              "value": "<string>",
              "customId": "<string>"
            }
          ],
          "perColorValues": [
            {
              "styleColorId": 123,
              "value": {
                "id": 123,
                "value": "<string>",
                "customId": "<string>"
              },
              "values": [
                {
                  "id": 123,
                  "value": "<string>",
                  "customId": "<string>"
                }
              ]
            }
          ]
        }
      ],
      "properties": [
        "<string>"
      ]
    }
  ]
}

{
  "status": "success",
  "code": "<string>",
  "error": {
    "operation": "<string>",
    "total_items": 123,
    "failed_items": 123,
    "summary": "<string>",
    "details": [
      {
        "type": "<string>",
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
}

{
  "status": "success",
  "code": "<string>",
  "error": {
    "details": [
      {
        "type": "<string>",
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
}

{
  "status": "success",
  "code": "<string>",
  "error": {
    "operation": "<string>",
    "total_items": 123,
    "failed_items": 123,
    "summary": "<string>",
    "details": [
      {
        "type": "<string>",
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
}

{
  "status": "success",
  "code": "<string>",
  "error": {
    "operation": "<string>",
    "total_items": 123,
    "failed_items": 123,
    "summary": "<string>",
    "details": [
      {
        "type": "<string>",
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
}

{
  "status": "success",
  "code": "<string>",
  "error": {
    "operation": "<string>",
    "total_items": 123,
    "failed_items": 123,
    "summary": "<string>",
    "details": [
      {
        "type": "<string>",
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
}

{
  "status": "success",
  "code": "<string>",
  "error": {
    "details": [
      {
        "type": "<string>",
        "field": "<string>",
        "value": "<string>"
      }
    ]
  }
}

Path Parameters

styleId

integer<int64>

required

Identifier of the style whose color assignments are addressed.

Body

colorId

integer<int64>

Identifier of the color already assigned to the style whose state this item sets.

state

null | enum<string>

Lifecycle state of the color group, indicating whether it is available for use.

Available options:

active,

inactive,

deleted

Response

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.

Show child attributes