Создать список

POST /v1/lists

Создаёт новый список — инфоблок типа lists, lists_socnet или bitrix_processes. Символьный код нового списка передаётся полем iblockCode на верхнем уровне тела, вне обёртки fields, а настройки списка идут внутри fields в форме Битрикс24.

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

Поле Тип Обяз. Описание
iblockCode string да Символьный код нового списка. Передаётся на верхнем уровне тела, вне обёртки fields
fields object да Настройки списка в форме Битрикс24. Ключи внутри — в верхнем регистре с подчёркиванием
fields.NAME string да Название списка
fields.DESCRIPTION string нет Описание списка
fields.SORT number нет Индекс сортировки в перечне списков
fields.BIZPROC string нет Включение бизнес-процессов: Y или N
iblockTypeId string нет Тип инфоблока. Значения:
lists — обычные списки, по умолчанию
lists_socnet — списки рабочих групп
bitrix_processes — служебные бизнес-процессы
socnetGroupId number нет ID рабочей группы. Обязателен, когда iblockTypeId равен lists_socnet, для остальных типов не используется
messages object нет Подписи интерфейса списка — названия для разделов и элементов
rights object нет Права доступа к списку по идентификаторам Битрикс24

Примеры

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/lists \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "iblockCode": "orders_registry",
    "fields": {
      "NAME": "Реестр заявок",
      "DESCRIPTION": "Заявки на обработку",
      "SORT": 100
    }
  }'

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

Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/lists \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "iblockCode": "orders_registry",
    "fields": {
      "NAME": "Реестр заявок",
      "DESCRIPTION": "Заявки на обработку",
      "SORT": 100
    }
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/lists', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    iblockCode: 'orders_registry',
    fields: {
      NAME: 'Реестр заявок',
      DESCRIPTION: 'Заявки на обработку',
      SORT: 100,
    },
  }),
})

const { data } = await res.json()
console.log('ID списка:', data.id)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/lists', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    iblockCode: 'orders_registry',
    fields: {
      NAME: 'Реестр заявок',
      DESCRIPTION: 'Заявки на обработку',
      SORT: 100,
    },
  }),
})

const { data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.id number Идентификатор созданного списка IBLOCK_ID

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

JSON 
{
  "success": true,
  "data": {
    "id": 133
  }
}

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

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

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FIELDS",
    "message": "`iblockCode` is required (the symbolic code of the new list)."
  }
}

Ошибки

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

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

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

Адресация по коду или числовому идентификатору. Созданный список доступен в последующих вызовах /v1/lists/:iblockId и по числовому id из ответа, и по символьному коду из iblockCode.

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