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

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

PATCH /v1/crm-settings/:id

Меняет настройку CRM всего портала. Используйте ключ с правом записи и сверяйте схему значения перед изменением.

Доступность: в облаке метод доступен. Для коробочной установки требуется обновление CRM crm 26.2000.0. Без него API вернёт 422 METHOD_NOT_YET_AVAILABLE с требуемым выпуском в error.release.

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типstring Обяз.да ОписаниеИдентификатор из списка настроек.

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

Поле Тип Обяз. Описание
Полеvalue Типany JSON Обяз.да ОписаниеПолное значение по meta.schema из чтения настройки. Поле обязательно, даже если значение — null, false или 0.

Примеры

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

Terminal
curl -X PATCH "https://vibecode.bitrix24.tech/v1/crm-settings/crm.layout.file_previewer.enabled" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"value": true}'

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

Terminal
curl -X PATCH "https://vibecode.bitrix24.tech/v1/crm-settings/crm.layout.file_previewer.enabled" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"value": true}'

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

javascript
const response = await fetch('https://vibecode.bitrix24.tech/v1/crm-settings/crm.layout.file_previewer.enabled', {
  method: 'PATCH',
  headers: {"X-Api-Key": "YOUR_API_KEY", "Content-Type": "application/json"},
  body: JSON.stringify({"value": true}),
})
const result = await response.json()

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

javascript
const response = await fetch('https://vibecode.bitrix24.tech/v1/crm-settings/crm.layout.file_previewer.enabled', {
  method: 'PATCH',
  headers: {"X-Api-Key": "YOUR_APP_KEY", "Authorization": "Bearer USER_SESSION_TOKEN", "Content-Type": "application/json"},
  body: JSON.stringify({"value": true}),
})
const result = await response.json()

Поля ответа

Поле Описание
Полеdata.id ОписаниеИдентификатор.
Полеdata.value ОписаниеЗначение JSON без преобразования типов.
Полеdata.meta.title ОписаниеНазвание настройки.
Полеdata.meta.description ОписаниеОписание настройки.
Полеdata.meta.schema ОписаниеСхема допустимого значения. Проверяется Битрикс24.

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

Пример структуры с нейтральными данными.

JSON
{
  "success": true,
  "data": {
    "id": "crm.layout.file_previewer.enabled",
    "value": true,
    "meta": {
      "title": "File preview",
      "description": "Preview files",
      "schema": {
        "type": "boolean"
      }
    }
  }
}

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

400 — неизвестный параметр или отсутствует обязательное поле:

JSON
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FIELDS",
    "message": "value is required"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодBITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION ОписаниеЗначение не прошло проверку по meta.schema. Причина — в error.validation.
HTTP400 КодUNKNOWN_FILTER_FIELD ОписаниеНеизвестный параметр запроса.
HTTP400 КодMISSING_REQUIRED_FIELDS ОписаниеНет обязательного поля тела.
HTTP400 КодUNKNOWN_FIELD ОписаниеНеизвестное поле тела.
HTTP401 КодTOKEN_MISSING ОписаниеНет доступа к Битрикс24 у ключа.
HTTP403 КодSCOPE_DENIED ОписаниеНужен скоуп crm.
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеЗапись запрещена режимом ключа.
HTTP404 КодENTITY_NOT_FOUND ОписаниеЗапись отсутствует или недоступна.
HTTP422 КодMETHOD_NOT_YET_AVAILABLE ОписаниеНа портале нет метода. Требуемый выпуск указан в error.release.
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеОтвет Битрикс24 недоступен или имеет некорректную структуру.

Другие отказы Битрикс24 сохраняют исходные код и текст. Общие ошибки API.

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

Объект в value передаётся целиком, без частичного объединения. Успешное изменение не отменяется, если чтение после записи завершилось ошибкой. Не повторяйте запись вслепую после неоднозначного сбоя: сначала прочитайте настройку.

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