Создать универсальный список lists.add
Scope:
listsКто может выполнять метод: администратор
Метод lists.add создает универсальный список.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
IBLOCK_TYPE_ID* |
Идентификатор типа инфоблока. Возможные значения:
|
|
IBLOCK_CODE* |
Cимвольный код инфоблока |
|
SOCNET_GROUP_ID |
Идентификатор группы. Используйте параметр, если хотите добавить список в группу. Идентификатор можно получить с помощью методов socialnetwork.api.workgroup.list, sonet_group.get и sonet_group.user.groups |
|
FIELDS* |
Массив полей списка. |
|
MESSAGES |
Массив подписей к элементам и разделам списка. Поддерживаемые значения:
|
|
RIGHTS |
Настройка прав доступа к списку. Массив в формате ключ-значение, где ключ — это буквенный код пользователя или отдела с идентификатором, а значение — буквенный код права.
Категории пользователей:
Получить идентификатор пользователя можно с помощью метода user.get, идентификатор отдела — методом department.get. Виды прав:
Если параметр не передан, авторизованному пользователю, который вызвал метод, назначается полный доступ |
Параметр FIELDS
Обязательные параметры отмечены *
|
Название |
Описание |
|
NAME* |
Название списка |
|
DESCRIPTION |
Описание списка |
|
SORT |
Сортировка |
|
PICTURE |
Картинка. Объект в формате |
|
BIZPROC |
Включение поддержки бизнес-процессов. Возможные значения:
|
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_CODE":"my_custom_list","FIELDS":{"NAME":"Мой новый список","DESCRIPTION":"Список для отслеживания задач в проекте","SORT":500,"BIZPROC":"Y"},"MESSAGES":{"ELEMENTS_NAME":"Задачи","ELEMENT_NAME":"Задача","ELEMENT_ADD":"Добавить задачу","ELEMENT_EDIT":"Изменить задачу","ELEMENT_DELETE":"Удалить задачу","SECTIONS_NAME":"Разделы","SECTION_NAME":"Раздел","SECTION_ADD":"Добавить раздел","SECTION_EDIT":"Изменить раздел","SECTION_DELETE":"Удалить раздел"},"RIGHTS":{"U1271":"X"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/lists.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_CODE":"my_custom_list","FIELDS":{"NAME":"Мой новый список","DESCRIPTION":"Список для отслеживания задач в проекте","SORT":500,"BIZPROC":"Y"},"MESSAGES":{"ELEMENTS_NAME":"Задачи","ELEMENT_NAME":"Задача","ELEMENT_ADD":"Добавить задачу","ELEMENT_EDIT":"Изменить задачу","ELEMENT_DELETE":"Удалить задачу","SECTIONS_NAME":"Разделы","SECTION_NAME":"Раздел","SECTION_ADD":"Добавить раздел","SECTION_EDIT":"Изменить раздел","SECTION_DELETE":"Удалить раздел"},"RIGHTS":{"U1271":"X"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/lists.add
try {
const response = await $b24.callMethod(
'lists.add',
{
IBLOCK_TYPE_ID: 'lists',
IBLOCK_CODE: 'my_custom_list',
FIELDS: {
NAME: 'Мой новый список',
DESCRIPTION: 'Список для отслеживания задач в проекте',
SORT: 500,
BIZPROC: 'Y'
},
MESSAGES: {
ELEMENTS_NAME: 'Задачи',
ELEMENT_NAME: 'Задача',
ELEMENT_ADD: 'Добавить задачу',
ELEMENT_EDIT: 'Изменить задачу',
ELEMENT_DELETE: 'Удалить задачу',
SECTIONS_NAME: 'Разделы',
SECTION_NAME: 'Раздел',
SECTION_ADD: 'Добавить раздел',
SECTION_EDIT: 'Изменить раздел',
SECTION_DELETE: 'Удалить раздел'
},
RIGHTS: {
'U1271': 'X'
}
}
);
const result = response.getData().result;
console.log('Created list with ID:', result);
processResult(result);
} catch (error) {
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'lists.add',
[
'IBLOCK_TYPE_ID' => 'lists',
'IBLOCK_CODE' => 'my_custom_list',
'FIELDS' => [
'NAME' => 'Мой новый список',
'DESCRIPTION' => 'Список для отслеживания задач в проекте',
'SORT' => 500,
'BIZPROC' => 'Y'
],
'MESSAGES' => [
'ELEMENTS_NAME' => 'Задачи',
'ELEMENT_NAME' => 'Задача',
'ELEMENT_ADD' => 'Добавить задачу',
'ELEMENT_EDIT' => 'Изменить задачу',
'ELEMENT_DELETE' => 'Удалить задачу',
'SECTIONS_NAME' => 'Разделы',
'SECTION_NAME' => 'Раздел',
'SECTION_ADD' => 'Добавить раздел',
'SECTION_EDIT' => 'Изменить раздел',
'SECTION_DELETE' => 'Удалить раздел'
],
'RIGHTS' => [
'U1271' => 'X'
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding list: ' . $e->getMessage();
}
BX24.callMethod(
'lists.add',
{
IBLOCK_TYPE_ID: 'lists',
IBLOCK_CODE: 'my_custom_list',
FIELDS: {
NAME: 'Мой новый список',
DESCRIPTION: 'Список для отслеживания задач в проекте',
SORT: 500,
BIZPROC: 'Y'
},
MESSAGES: {
ELEMENTS_NAME: 'Задачи',
ELEMENT_NAME: 'Задача',
ELEMENT_ADD: 'Добавить задачу',
ELEMENT_EDIT: 'Изменить задачу',
ELEMENT_DELETE: 'Удалить задачу',
SECTIONS_NAME: 'Разделы',
SECTION_NAME: 'Раздел',
SECTION_ADD: 'Добавить раздел',
SECTION_EDIT: 'Изменить раздел',
SECTION_DELETE: 'Удалить раздел'
},
RIGHTS: {
'U1271': 'X', // пользователь с ID=1271 — полный доступ
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'lists.add',
[
'IBLOCK_TYPE_ID' => 'lists',
'IBLOCK_CODE' => 'my_custom_list',
'FIELDS' => [
'NAME' => 'Мой новый список',
'DESCRIPTION' => 'Список для отслеживания задач в проекте',
'SORT' => 500,
'BIZPROC' => 'Y'
],
'MESSAGES' => [
'ELEMENTS_NAME' => 'Задачи',
'ELEMENT_NAME' => 'Задача',
'ELEMENT_ADD' => 'Добавить задачу',
'ELEMENT_EDIT' => 'Изменить задачу',
'ELEMENT_DELETE' => 'Удалить задачу',
'SECTIONS_NAME' => 'Разделы',
'SECTION_NAME' => 'Раздел',
'SECTION_ADD' => 'Добавить раздел',
'SECTION_EDIT' => 'Изменить раздел',
'SECTION_DELETE' => 'Удалить раздел'
],
'RIGHTS' => [
'U1271' => 'X'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": 109,
"time": {
"start": 1764675143,
"finish": 1764675143.174578,
"duration": 0.17457795143127441,
"processing": 0,
"date_start": "2025-12-02T14:32:23+03:00",
"date_finish": "2025-12-02T14:32:23+03:00",
"operating_reset_at": 1764675743,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Идентификатор созданного инфоблока |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":"ERROR_IBLOCK_ALREADY_EXISTS",
"error_description":"Iblock already exists"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Required parameter |
Обязательный параметр не передан |
|
|
Iblock already exists |
Список с таким |
|
|
— |
Ошибка при добавлении списка |
|
|
Access denied |
Метод запустил не администратор |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Обновить универсальный список lists.update
- Получить данные универсального списка или массив списков lists.get
- Удалить универсальный список lists.delete
- Получить идентификатор типа инфоблока lists.get.iblock.type.id