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

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

PATCH /v1/tasks/:taskId/checklist/:itemId

Частичное обновление пункта чек-листа — передавайте только изменяемые поля.

Параметры

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

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

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

Хотя бы одно из перечисленных полей обязательно.

Примеры

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

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

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

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

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

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

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

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

Поля ответа

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

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

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

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

400 — пустое тело запроса:

JSON 
{
  "success": false,
  "error": { "code": "INVALID_PARAMS", "message": "No updatable fields provided" }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеПустое тело, taskId/itemId не положительное целое, неизвестный формат members, либо нарушен тип поля
HTTP404 КодNOT_FOUND ОписаниеПункт с указанным 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 — Ошибки.

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

  • Несуществующий taskId даёт 200. Если задачи с таким идентификатором нет, ответ приходит успешный, с переданным itemId, но ничего не обновляется. Отказ 404 приходит только на несуществующий пункт внутри существующей задачи. Проверить задачу можно через «Получить задачу».

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