For AI agents: markdown of this page — /docs-content-en/entities/tasks/checklist/update.md documentation index — /llms.txt

Update a checklist item

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

Partial update of a checklist item — pass only the fields you want to change.

Parameters

Parameter Type Required Description
ParametertaskId (path) Typeinteger Requiredyes DescriptionTask ID. List: GET /v1/tasks
ParameteritemId (path) Typeinteger Requiredyes DescriptionChecklist item ID. List: GET /v1/tasks/:taskId/checklist

Request fields (body)

Field Type Required Description
Fieldtitle Typestring Requiredno DescriptionItem text
FieldsortIndex Typeinteger Requiredno DescriptionSort index
FieldisComplete Typeboolean / Y,N Requiredno DescriptionCompletion status
FieldisImportant Typeboolean / Y,N Requiredno DescriptionImportance flag
FieldparentId Typeinteger Requiredno DescriptionParent item ID. The value 0 starts a new checklist
Fieldmembers Typeobject Requiredno DescriptionItem members: { "<userId>": { "type": "A" | "U" } }, where A is a co-assignee and U is an observer. Replaces the current list entirely: to keep the current members, pass them together with the new ones

At least one of the fields above is required.

Examples

curl — personal key

Terminal 
curl -X PATCH "https://vibecode.bitrix24.com/v1/tasks/3943/checklist/213" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "title": "Collect and check documents", "isImportant": true }'

curl — OAuth application

Terminal 
curl -X PATCH "https://vibecode.bitrix24.com/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": "Collect and check documents", "isImportant": true }'

JavaScript — personal key

javascript 
const res = await fetch("https://vibecode.bitrix24.com/v1/tasks/3943/checklist/213", {
  method: "PATCH",
  headers: {
    "X-Api-Key": "YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ title: "Collect and check documents", isImportant: true }),
});
const { data } = await res.json();

JavaScript — OAuth application

javascript 
const res = await fetch("https://vibecode.bitrix24.com/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: "Collect and check documents", isImportant: true }),
});
const { data } = await res.json();

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata.id Typenumber DescriptionID of the updated item

Response example

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

Error response example

400 — an empty request body:

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

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptionEmpty body, taskId/itemId is not a positive integer, an unknown members shape, or a field type violation
HTTP404 CodeNOT_FOUND DescriptionThe item with the given itemId does not exist or is not accessible to the key
HTTP403 CodeSCOPE_DENIED DescriptionThe API key lacks the task scope
HTTP403 CodeWRITE_BLOCKED_READONLY_KEY DescriptionThe key is in read-only mode. Open the path from error.details.switchUrl: a personal key points to /keys, an application key with a card to /applications, a standalone OAuth key to /apps, and a management key to /management-keys. Switch it to read and write there
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no configured tokens

Full list of common API errors — Errors.

Known specifics

  • A nonexistent taskId returns 200. When no task with that identifier exists, the response is successful and echoes the given itemId, but nothing is updated. A 404 is returned only for a missing item inside an existing task. To check the task, call "Get a task".

See also