Для AI-агентов: markdown этой страницы — /docs-content/lists/sections/update.md индекс документации — /llms.txt
Обновить раздел
PATCH /v1/lists/:iblockId/sections/:sectionId
Изменяет поля существующего раздела списка. Изменяемые поля передаются внутри объекта fields в форме Битрикс24.
Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
iblockId (path) |
string | да | Идентификатор или символьный код списка. Значения — поля ID или CODE метода Список списков |
sectionId (path) |
number | да | Идентификатор раздела, положительное целое число из поля ID метода Разделы списка |
Поля запроса (body)
| Поле | Тип | Обяз. | Описание |
|---|---|---|---|
fields |
object | да | Изменяемые поля раздела. Ключи — в верхнем регистре с подчёркиванием |
fields.NAME |
string | да | Непустое название раздела. Передавайте и при изменении других полей. Текущее название — в поле NAME метода Получить раздел |
fields.CODE |
string | нет | Символьный код раздела |
fields.SORT |
number | нет | Индекс сортировки |
fields.ACTIVE |
string | нет | Активность раздела: Y или N |
fields.IBLOCK_SECTION_ID |
number | нет | Идентификатор родительского раздела из поля ID метода Разделы списка. 0 — перенести раздел в корень списка |
fields.XML_ID |
string | нет | Внешний идентификатор раздела для обмена данными |
fields.EXTERNAL_ID |
string | нет | Другое имя поля XML_ID |
fields.DESCRIPTION |
string | нет | Описание раздела. Пустая строка очищает описание |
fields.DESCRIPTION_TYPE |
string | нет | Формат описания: text или html |
fields.PICTURE |
array | нет | Изображение раздела: массив ["имя_файла.png", "BASE64_DATA"]. Во втором элементе — содержимое файла в Base64 |
iblockTypeId |
string | нет | Тип инфоблока. Значения:lists — обычные списки, по умолчаниюlists_socnet — списки рабочих группbitrix_processes — служебные бизнес-процессыstructure — тип структуры компании (здесь лежит штатный инфоблок графика отсутствий absence) |
socnetGroupId |
number | нет | Идентификатор рабочей группы, в которой находится список. Для списка группы передайте iblockTypeId: "lists_socnet" и ID группы из поля id метода Список рабочих групп. Для обычного списка не передавайте |
Передавайте изменяемые поля и fields.NAME. Остальные настройки раздела сохраняют прежние значения.
Примеры
curl — личный ключ
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-приложение
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 — личный ключ
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-приложение
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()
Поля ответа
HTTP 200. Чтобы получить изменённые поля, вызовите Получить раздел.
| Поле | Тип | Описание |
|---|---|---|
success |
boolean | Всегда true при успехе |
data |
object | Результат обновления |
data.updated |
boolean | true при успешном обновлении |
Пример ответа
{
"success": true,
"data": {
"updated": true
}
}
Пример ответа при ошибке
422 — не передано название раздела fields.NAME:
{
"success": false,
"error": {
"code": "BITRIX_ERROR",
"message": "Required parameter \"NAME\" is missing",
"b24Code": "ERROR_REQUIRED_PARAMETERS_MISSING"
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| 400 | INVALID_PARAMS |
sectionId не является положительным целым числом |
| 400 | MISSING_REQUIRED_FIELDS |
fields отсутствует или не является объектом |
| 400 | INVALID_IBLOCK_TYPE |
iblockTypeId не входит в набор lists, lists_socnet, bitrix_processes, structure |
| 422 | BITRIX_ERROR |
Не передано fields.NAME, в том числе при пустом fields. В ответе b24Code: "ERROR_REQUIRED_PARAMETERS_MISSING" |
| 422 | BITRIX_ERROR |
В fields.NAME передана пустая строка. В ответе b24Code: "ERROR_UPDATE_SECTION" |
| 422 | BITRIX_ERROR |
Раздел или список не существует. В ответе b24Code: "ERROR_SECTION_NOT_FOUND" |
| 422 | BITRIX_ERROR |
Тип списка не соответствует параметрам запроса, например socnetGroupId передан для обычного списка. В ответе b24Code: "0" |
| 403 | BITRIX_ACCESS_DENIED |
Нет прав на список или раздел |
| 409 | LISTS_MODULE_NOT_ENABLED |
На портале Битрикс24 не подключён модуль «Списки» |
| 403 | WRITE_BLOCKED_READONLY_KEY |
Ключ работает в режиме только чтения |
| 403 | SCOPE_DENIED |
Ключу не хватает скоупа lists |
| 401 | TOKEN_MISSING |
У ключа не настроены токены доступа |
Полный список общих ошибок API — Ошибки.