Обновить раздел

PATCH /v1/lists/:iblockId/sections/:sectionId

Изменяет поля существующего раздела списка. Изменяемые поля передаются внутри объекта fields в форме Битрикс24.

Параметры

Параметр Тип Обяз. Описание
iblockId (path) string да Числовой IBLOCK_ID или символьный код списка
sectionId (path) number да Числовой идентификатор раздела. Список разделов: GET /v1/lists/:iblockId/sections

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

Поле Тип Обяз. Описание
fields object да Изменяемые поля раздела в форме Битрикс24. Ключи внутри — в верхнем регистре с подчёркиванием, например NAME, SORT, DESCRIPTION
iblockTypeId string нет Тип инфоблока. Значения:
lists — обычные списки, по умолчанию
lists_socnet — списки рабочих групп
bitrix_processes — служебные бизнес-процессы

Примеры

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

Terminal 
curl -X PATCH https://vibecode.bitrix24.tech/v1/lists/23/sections/215 \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fields": {
      "NAME": "Северо-Западный регион",
      "SORT": 200
    }
  }'

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

Terminal 
curl -X PATCH https://vibecode.bitrix24.tech/v1/lists/23/sections/215 \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "fields": {
      "NAME": "Северо-Западный регион",
      "SORT": 200
    }
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/lists/23/sections/215', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    fields: {
      NAME: 'Северо-Западный регион',
      SORT: 200,
    },
  }),
})

const { data } = await res.json()
console.log(data.updated)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/lists/23/sections/215', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    fields: {
      NAME: 'Северо-Западный регион',
      SORT: 200,
    },
  }),
})

const { data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.updated boolean true при успешном обновлении

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

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

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

400 — не передан обязательный параметр:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FIELDS",
    "message": "`fields` is required and must be an object."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS sectionId не является положительным целым числом
400 MISSING_REQUIRED_FIELDS Не передан объект fields
400 INVALID_IBLOCK_TYPE iblockTypeId не входит в набор lists, lists_socnet, bitrix_processes
403 BITRIX_ACCESS_DENIED Раздел или список не существует, либо у ключа нет прав на него
409 LISTS_MODULE_NOT_ENABLED На портале Битрикс24 не подключён модуль «Списки»
403 WRITE_BLOCKED_READONLY_KEY Ключ работает в режиме только чтения
403 SCOPE_DENIED Ключу не хватает скоупа lists
401 TOKEN_MISSING У ключа не настроены токены доступа

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

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