Для AI-агентов: markdown этой страницы — /docs-content/chats/management/color.md индекс документации — /llms.txt

Изменить цвет чата

PUT /v1/chats/:dialogId/color

Задаёт цвет чата одним из семнадцати кодов палитры Битрикс24. Цвет в формате RGB не принимается.

Параметры

Параметр Тип Обяз. Описание
dialogId (path) string да ID диалога: chatXXX для группового чата, числовой ID пользователя для личных сообщений, me — личный диалог текущего пользователя. Чат сущности CRM находится через Найти чат CRM-сущности

Query-параметров у эндпоинта нет: любой параметр в строке запроса отклоняется с 400 INVALID_PARAMS.

Поля запроса (body)

Поле Тип Обяз. Описание
color string да Код цвета из таблицы ниже, в любом регистре: mint и MINT равнозначны

Другие поля тела отклоняются с 400 INVALID_PARAMS, сообщение называет лишнее поле.

Коды палитры и цвет, которым чат с этим кодом приходит в поле color ответа Информация о диалоге. Значение #rrggbb в запросе отклоняется.

Код Цвет в ответе чата
RED #df532d
GREEN #64a513
MINT #4ba984
LIGHT_BLUE #4ba5c3
DARK_BLUE #3e99ce
PURPLE #8474c8
AQUA #1eb4aa
PINK #f76187
LIME #58cc47
BROWN #ab7761
AZURE #29619b
KHAKI #728f7a
SAND #ba9c7b
MARENGO #556574
GRAY #909090
GRAPHITE #5e5f5e
COPILOT #8d51eb

Примеры

curl — личный ключ

Terminal 
curl -X PUT https://vibecode.bitrix24.tech/v1/chats/chat2741/color \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"color": "MINT"}'

curl — OAuth-приложение

Terminal 
curl -X PUT https://vibecode.bitrix24.tech/v1/chats/chat2741/color \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"color": "MINT"}'

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat2741/color', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ color: 'MINT' }),
})

const { success } = await res.json()

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat2741/color', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ color: 'MINT' }),
})

const { success } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data boolean true — цвет сохранён

Пример ответа

JSON 
{
  "success": true,
  "data": true
}

Пример ответа при ошибке

400 — передан цвет в формате #rrggbb вместо кода:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Body field `color` must be a palette code: RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, PINK, LIME, BROWN, AZURE, KHAKI, SAND, MARENGO, GRAY, GRAPHITE, COPILOT (any case). A hex value is not accepted — the portal stores codes, and replaces any other value with a colour of its own choice."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS color нет в теле или это не код из палитры, в теле другое поле, тело не JSON-объект, в строке запроса есть параметр. Проверяется до обращения к Битрикс24
403 BITRIX_ACCESS_DENIED Битрикс24 отказал: пользователь не участник чата или право ui не разрешает ему менять цвет
422 BITRIX_ERROR Битрикс24 вернул ошибку, код портала — в error.b24Code. Чата нет — CHAT_NOT_FOUND
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ в режиме «только чтение» — изменение цвета считается записью
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24
502 ME_ALIAS_RESOLUTION_FAILED dialogId=me — не удалось определить ID текущего пользователя
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ошибку сервера

Полный список общих ошибок API — Ошибки.

Известные особенности

Значение вне палитры отклоняется до записи. Код ORANGE, значение #rrggbb и опечатка в коде не доходят до Битрикс24: портал сохранил бы вместо них цвет по своему выбору и ответил успехом. Поэтому эндпоинт отвечает 400 INVALID_PARAMS, а цвет чата остаётся прежним.

Без системного сообщения. Смена цвета не пишет в чат системного сообщения, в отличие от смены аватара.

Смотрите также