Для AI-агентов: markdown этой страницы — /docs-content/entities/tasks/checklist/create.md индекс документации — /llms.txt

Добавить пункт чек-листа

POST /v1/tasks/:taskId/checklist

Добавляет пункт в чек-лист задачи. title обязателен. Возвращает id нового пункта.

Параметры

Параметр Тип Обяз. Описание
ПараметрtaskId (path) Типinteger Обяз.да ОписаниеID задачи

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

Поле Тип Обяз. Описание
Полеtitle Типstring Обяз.да ОписаниеТекст пункта. Если parentId: 0, становится названием нового чек-листа
ПолеsortIndex Типinteger Обяз.нет ОписаниеИндекс сортировки. Чем меньше значение, тем выше пункт в списке
ПолеisImportant Типboolean / Y,N Обяз.нет ОписаниеПризнак важности
ПолеisComplete Типboolean / Y,N Обяз.нет ОписаниеСтатус выполнения при создании
ПолеparentId Типinteger Обяз.нет ОписаниеID родительского пункта. 0 создаёт новый чек-лист-контейнер в задаче
Полеmembers Типobject Обяз.нет ОписаниеУчастники пункта: { "<userId>": { "type": "A" | "U" } }. A — соисполнитель, U — наблюдатель. Список сотрудников — GET /v1/users

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/tasks/3943/checklist" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Собрать и проверить документы",
    "sortIndex": 100,
    "isImportant": true
  }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/tasks/3943/checklist" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Собрать и проверить документы",
    "sortIndex": 100,
    "isImportant": true
  }'

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

javascript 
const res = await fetch("https://vibecode.bitrix24.tech/v1/tasks/3943/checklist", {
  method: "POST",
  headers: {
    "X-Api-Key": "YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    title: "Собрать и проверить документы",
    sortIndex: 100,
    isImportant: true,
  }),
});
const { data } = await res.json();

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

javascript 
const res = await fetch("https://vibecode.bitrix24.tech/v1/tasks/3943/checklist", {
  method: "POST",
  headers: {
    "X-Api-Key": "YOUR_APP_KEY",
    "Authorization": "Bearer USER_SESSION_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    title: "Собрать и проверить документы",
    sortIndex: 100,
    isImportant: true,
  }),
});
const { data } = await res.json();

Чтобы создать новый чек-лист (контейнер верхнего уровня), передайте parentId: 0 — в этом случае title становится названием чек-листа:

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/tasks/3943/checklist" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "title": "Документы", "parentId": 0 }'

Поля ответа

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

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

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

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

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

JSON 
{
  "success": false,
  "error": { "code": "INVALID_PARAMS", "message": "`title` is required" }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеНе передан title, taskId не положительное целое, неизвестный формат members, либо parentId отрицательный
HTTP404 КодTASK_NOT_FOUND ОписаниеЗадача taskId не существует или недоступна ключу — перед добавлением пункта Вайбкод проверяет родительскую задачу отдельным вызовом
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа task
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч в режиме только чтения. Откройте путь из error.details.switchUrl: личный ключ ведёт на /keys, ключ приложения с карточкой — на /applications, самостоятельный OAuth-ключ — на /apps, management-ключ — на /management-keys. Там переключите режим на чтение и запись
HTTP401 КодTOKEN_MISSING ОписаниеAPI-ключ не имеет настроенных токенов

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

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

  • parentId: 0 создаёт новый чек-лист-контейнер, а не обычный пункт — title в этом случае становится названием контейнера.
  • Пункт без указанного parentId может лечь в уже существующий чек-лист. Если в задаче уже есть контейнер (parentId: 0), Битрикс24 подставляет его новым пунктам вместо того, чтобы оставить их на верхнем уровне — если нужен независимый контейнер, создавайте его явно через parentId: 0.
  • members на запись — объект по userId, не массив. Формат ответа (в GET) отличается — см. «Список пунктов».

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