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 or removes colors across one or more styles.
Body is always an array, even for a single item. All-or-nothing across the whole batch. Each item identifies one (styleId, colorId) assignment; state=“deleted” soft-deletes it. Each returned color carries the same enriched customFields[] and properties[] (“hasCustomFieldOverrides”) as the GET routes. Capped at 200 items per request.
PUT
/
api
/
style-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>"
}
]
}
}Body
application/jsontext/jsonapplication/*+json
Identifier of the style whose color assignment this item updates or removes.
Identifier of the color assigned to the style whose state this item sets or removes.
Lifecycle state of the color group, indicating whether it is available for use.
Available options:
active, inactive, deleted Response
OK
The coarse outcome of the request, indicating whether it succeeded or failed.
Available options:
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