Обновить универсальный список lists.update

Scope: lists

Кто может выполнять метод: пользователь с правом «Полный доступ» для нужного списка

Метод lists.update обновляет универсальный список.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

IBLOCK_TYPE_ID*
string

Идентификатор типа инфоблока. Возможные значения:

  • lists — тип инфоблока списка
  • bitrix_processes — тип инфоблока процессов
  • lists_socnet — тип инфоблока списков групп

Идентификатор можно получить с помощью метода lists.get.iblock.type.id

IBLOCK_ID*
integer

Идентификатор инфоблока.

Идентификатор можно получить с помощью метода lists.get

IBLOCK_CODE*
string

Cимвольный код инфоблока.

Код можно получить с помощью метода lists.get

Необходимо указать хотя бы один из параметров: IBLOCK_ID или IBLOCK_CODE

SOCNET_GROUP_ID
integer

Идентификатор группы. Для изменения настроек списка указывать не нужно. Используйте параметр, если хотите перенести список в другую группу.

Идентификатор можно получить с помощью методов socialnetwork.api.workgroup.list, sonet_group.get и sonet_group.user.groups

FIELDS*
array

Массив полей списка.

Подробное описание

MESSAGES
array

Массив подписей к элементам и разделам списка. Поддерживаемые значения:

  • ELEMENTS_NAME — название элементов
  • ELEMENT_NAME — название элемента
  • ELEMENT_ADD — добавить элемент
  • ELEMENT_EDIT — изменить элемент
  • ELEMENT_DELETE — удалить элемент
  • SECTIONS_NAME — название разделов
  • SECTION_NAME — название раздела
  • SECTION_ADD — добавить раздел
  • SECTION_EDIT — изменить раздел
  • SECTION_DELETE — удалить раздел

RIGHTS
array

Настройка прав доступа к списку. Массив в формате ключ-значение, где ключ — это буквенный код пользователя или отдела с идентификатором, а значение — буквенный код права.

RIGHTS: {
            'U1': 'X', // Пользователю с ID=1 — полный доступ
            'D5': 'D'  // Сотрудникам отдела с ID=5 — запрет доступа
        }
        

Категории пользователей:

  • U — пользователь
  • * — все пользователи
  • D — все сотрудники отдела
  • DR — все сотрудники отдела с подотделами

Получить идентификатор пользователя можно с помощью метода user.get, идентификатор отдела — методом department.get.

Виды прав:

  • D — нет доступа
  • R — чтение
  • E — добавление
  • S — просмотр в панели
  • T — добавление в панели
  • U — изменение с ограничениями
  • W — изменение
  • X — полный доступ

Назначить права доступа можно только пользователям или отделам, у которых их еще нет. Нельзя изменить уже существующие права

Параметр FIELDS

Обязательные параметры отмечены *

Название
тип

Описание

NAME*
string

Название списка

DESCRIPTION
string

Описание списка

SORT
integer

Сортировка

PICTURE
array

Картинка. Объект в формате {fileData: [value1, value2]}, где value1 — название файла картинки с расширением, value2 — картинка в формате base64

BIZPROC
string

Включение поддержки бизнес-процессов. Возможные значения:

  • Y — да
  • N — нет

Примеры кода

Как использовать примеры в документации

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_ID":109,"FIELDS":{"NAME":"Обновленный список задач","DESCRIPTION":"Обновленное описание: список для управления ежедневными задачами","SORT":600,"BIZPROC":"N"},"MESSAGES":{"ELEMENTS_NAME":"Пункты","ELEMENT_NAME":"Пункт","ELEMENT_ADD":"Создать пункт","ELEMENT_EDIT":"Редактировать пункт","ELEMENT_DELETE":"Удалить пункт","SECTIONS_NAME":"Категории","SECTION_NAME":"Категория","SECTION_ADD":"Добавить категорию","SECTION_EDIT":"Редактировать категорию","SECTION_DELETE":"Удалить категорию"},"RIGHTS":{"D15":"W"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/lists.update
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_ID":109,"FIELDS":{"NAME":"Обновленный список задач","DESCRIPTION":"Обновленное описание: список для управления ежедневными задачами","SORT":600,"BIZPROC":"N"},"MESSAGES":{"ELEMENTS_NAME":"Пункты","ELEMENT_NAME":"Пункт","ELEMENT_ADD":"Создать пункт","ELEMENT_EDIT":"Редактировать пункт","ELEMENT_DELETE":"Удалить пункт","SECTIONS_NAME":"Категории","SECTION_NAME":"Категория","SECTION_ADD":"Добавить категорию","SECTION_EDIT":"Редактировать категорию","SECTION_DELETE":"Удалить категорию"},"RIGHTS":{"D15":"W"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/lists.update
        
try {
          const response = await $b24.callMethod(
              'lists.update',
              {
                  IBLOCK_TYPE_ID: 'lists',
                  IBLOCK_ID: 109,
                  FIELDS: {
                    NAME: 'Обновленный список задач',
                    DESCRIPTION: 'Обновленное описание: список для управления ежедневными задачами',
                    SORT: 600,
                    BIZPROC: 'N'
                  },
                  MESSAGES: {
                    ELEMENTS_NAME: 'Пункты',
                    ELEMENT_NAME: 'Пункт',
                    ELEMENT_ADD: 'Создать пункт',
                    ELEMENT_EDIT: 'Редактировать пункт',
                    ELEMENT_DELETE: 'Удалить пункт',
                    SECTIONS_NAME: 'Категории',
                    SECTION_NAME: 'Категория',
                    SECTION_ADD: 'Добавить категорию',
                    SECTION_EDIT: 'Редактировать категорию',
                    SECTION_DELETE: 'Удалить категорию'
                  },
                  RIGHTS: {
                    'D15': 'W'
                  }
              }
          );
        
          const result = response.getData().result;
          console.log('Updated list with ID:', result);
          processResult(result);
        } catch (error) {
          console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'lists.update',
                    [
                        'IBLOCK_TYPE_ID' => 'lists',
                        'IBLOCK_ID' => 109,
                        'FIELDS' => [
                            'NAME' => 'Обновленный список задач',
                            'DESCRIPTION' => 'Обновленное описание: список для управления ежедневными задачами',
                            'SORT' => 600,
                            'BIZPROC' => 'N'
                        ],
                        'MESSAGES' => [
                            'ELEMENTS_NAME' => 'Пункты',
                            'ELEMENT_NAME' => 'Пункт',
                            'ELEMENT_ADD' => 'Создать пункт',
                            'ELEMENT_EDIT' => 'Редактировать пункт',
                            'ELEMENT_DELETE' => 'Удалить пункт',
                            'SECTIONS_NAME' => 'Категории',
                            'SECTION_NAME' => 'Категория',
                            'SECTION_ADD' => 'Добавить категорию',
                            'SECTION_EDIT' => 'Редактировать категорию',
                            'SECTION_DELETE' => 'Удалить категорию'
                        ],
                        'RIGHTS' => [
                            'D15' => 'W'
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating list: ' . $e->getMessage();
        }
        
BX24.callMethod(
        'lists.update',
        {
           IBLOCK_TYPE_ID: 'lists',
           IBLOCK_ID: 109,
           FIELDS: {
             NAME: 'Обновленный список задач',
             DESCRIPTION: 'Обновленное описание: список для управления ежедневными задачами',
             SORT: 600,
             BIZPROC: 'N' 
           },
           MESSAGES: {
             ELEMENTS_NAME: 'Пункты',
             ELEMENT_NAME: 'Пункт',
             ELEMENT_ADD: 'Создать пункт',
             ELEMENT_EDIT: 'Редактировать пункт',
             ELEMENT_DELETE: 'Удалить пункт',
             SECTIONS_NAME: 'Категории',
             SECTION_NAME: 'Категория',
             SECTION_ADD: 'Добавить категорию',
             SECTION_EDIT: 'Редактировать категорию',
             SECTION_DELETE: 'Удалить категорию'
           },
           RIGHTS: {
             'D15': 'W',    // сотрудники отдела с ID=15 — изменение
           }
        },
           function(result) {
              if (result.error()) {
                 console.error(result.error());
              } else {
                 console.log(result.data());
           }
         }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'lists.update',
            [
                'IBLOCK_TYPE_ID' => 'lists',
                'IBLOCK_ID' => 109,
                'FIELDS' => [
                    'NAME' => 'Обновленный список задач',
                    'DESCRIPTION' => 'Обновленное описание: список для управления ежедневными задачами',
                    'SORT' => 600,
                    'BIZPROC' => 'N'
                ],
                'MESSAGES' => [
                    'ELEMENTS_NAME' => 'Пункты',
                    'ELEMENT_NAME' => 'Пункт',
                    'ELEMENT_ADD' => 'Создать пункт',
                    'ELEMENT_EDIT' => 'Редактировать пункт',
                    'ELEMENT_DELETE' => 'Удалить пункт',
                    'SECTIONS_NAME' => 'Категории',
                    'SECTION_NAME' => 'Категория',
                    'SECTION_ADD' => 'Добавить категорию',
                    'SECTION_EDIT' => 'Редактировать категорию',
                    'SECTION_DELETE' => 'Удалить категорию'
                ],
                'RIGHTS' => [
                    'D15' => 'W'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Обработка ответа

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1764687690,
                "finish": 1764687690.350469,
                "duration": 0.35046911239624023,
                "processing": 0,
                "date_start": "2025-12-02T15:01:30+03:00",
                "date_finish": "2025-12-02T15:01:30+03:00",
                "operating_reset_at": 1764688290,
                "operating": 0
            }
        }
        

Возвращаемые данные

Название
тип

Описание

result
boolean

Возвращает true, если список обновлен успешно

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
            "error":"ERROR_IBLOCK_NOT_FOUND",
            "error_description":"Iblock not found"
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

Значение

ERROR_REQUIRED_PARAMETERS_MISSING

Required parameter X is missing

Обязательный параметр не передан

ERROR_IBLOCK_NOT_FOUND

Iblock not found

Список с таким IBLOCK_ID или IBLOCK_CODE не найден

ERROR_UPDATE_IBLOCK

Ошибка при обновлении списка

ACCESS_DENIED

Access denied

Недостаточно прав для обновления списка

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение