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

Изменить настройку

PATCH /v1/chats/settings

Меняет одну общую настройку мессенджера пользователя — звук, тему, отправку по Enter, приватность, схему уведомлений и другие.

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

Тело запроса — JSON-объект:

Поле	Тип	Обяз.	Описание
`name`	string	да	Имя настройки — ключ из ответа чтения настроек: буква, затем буквы, цифры или `_`, до 64 символов. Значение `status` не принимается
`value`	string \| boolean	да	Новое значение: строка или `true` / `false`. Пример строки — `dark` для `enableDarkTheme`
`userId`	number	нет	ID пользователя, чью настройку изменить, — положительное целое. По умолчанию — владелец ключа. Чужие настройки меняет только администратор Битрикс24. Список пользователей: `GET /v1/users`

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

Примеры

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

Terminal

curl -X PATCH "https://vibecode.bitrix24.tech/v1/chats/settings" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "enableDarkTheme", "value": "dark"}'

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

Terminal

curl -X PATCH "https://vibecode.bitrix24.tech/v1/chats/settings" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "enableDarkTheme", "value": "dark"}'

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/settings', {
  method: 'PATCH',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({ name: 'enableDarkTheme', value: 'dark' }),
})

const { success } = await res.json()
console.log('Принято:', success)

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/settings', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ name: 'enableDarkTheme', value: 'dark' }),
})

const { success } = await res.json()
console.log('Принято:', success)

Поля ответа

Поле	Тип	Описание
`success`	boolean	Всегда `true` при успехе
`data`	boolean	`true` — вызов принят. Не означает, что значение изменилось: см. «Известные особенности»

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

JSON

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

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

400 — попытка изменить статус как обычную настройку: