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

Отметить пункт выполненным

POST /v1/tasks/:taskId/checklist/:itemId/complete

Отмечает пункт чек-листа выполненным. Эквивалентно PATCH с телом { "isComplete": true }, но не требует передавать остальные поля.

Параметры

Параметр Тип Обяз. Описание
ПараметрtaskId (path) Типinteger Обяз.да ОписаниеID задачи. Список: GET /v1/tasks
ПараметрitemId (path) Типinteger Обяз.да ОписаниеID пункта чек-листа. Список: GET /v1/tasks/:taskId/checklist

Тело запроса не требуется.

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/tasks/3943/checklist/213/complete" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/tasks/3943/checklist/213/complete" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch("https://vibecode.bitrix24.tech/v1/tasks/3943/checklist/213/complete", {
  method: "POST",
  headers: { "X-Api-Key": "YOUR_API_KEY" },
});
const { data } = await res.json();

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

javascript 
const res = await fetch("https://vibecode.bitrix24.tech/v1/tasks/3943/checklist/213/complete", {
  method: "POST",
  headers: {
    "X-Api-Key": "YOUR_APP_KEY",
    "Authorization": "Bearer USER_SESSION_TOKEN",
  },
});
const { data } = await res.json();

Поля ответа

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

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

JSON 
{ "success": true, "data": { "id": 213, "isComplete": "Y" } }

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

400 — некорректный itemId:

JSON 
{
  "success": false,
  "error": { "code": "INVALID_PARAMS", "message": "taskId and itemId must be positive integers" }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеtaskId или itemId не положительное целое
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 — Ошибки.

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

  • Несуществующие itemId и taskId тоже дают 200. В ответе приходит переданный itemId и isComplete: "Y", даже если такого пункта нет — и даже если нет самой задачи. Успешный статус не подтверждает, что пункт существует и что отметка проставлена. Проверить наличие можно через «Получить пункт», он отвечает 404 и на отсутствующий пункт, и на отсутствующую задачу.
  • Отказ по отсутствию пункта здесь не замерен. Маршрут переводит отказ Битрикс24 «пункт не найден» в 404 NOT_FOUND, как соседние методы кластера, но на живом портале этот метод такого отказа не отдавал — проба вернула 200, а в тестах отказ воспроизведён только моком. Поэтому 404 не объявлен в списке ошибок выше.

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