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": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}Replaces a single color assignment's state on a style (full replace).
Full replace of the one (style, color) assignment. state is required and must be active or inactive; state=“deleted” is rejected (400) — use DELETE so the removal cascade fires. Returns the updated color with the same enriched customFields[]/properties[] as the GET routes. 403 if the style belongs to another organization; 404 if the style doesn’t exist or the color isn’t assigned to it.
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": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}Path Parameters
Identifier of the style whose color assignments are addressed.
Identifier of the color assigned to the style, from the organization's color library.
Body
Lifecycle state of the color group, indicating whether it is available for use.
active, inactive, deleted Response
OK
The coarse outcome of the request, indicating whether it succeeded or failed.
success, error The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire.
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
Show child attributes