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
`taskId` (path)	integer	yes	Task ID. List: `GET /v1/tasks`
`itemId` (path)	integer	yes	Checklist item ID. List: `GET /v1/tasks/:taskId/checklist`

Request fields (body)

Field	Type	Required	Description
`title`	string	no	Item text
`sortIndex`	integer	no	Sort index
`isComplete`	boolean / `Y`,`N`	no	Completion status
`isImportant`	boolean / `Y`,`N`	no	Importance flag
`parentId`	integer	no	Parent item ID. The value `0` starts a new checklist
`members`	object	no	Item 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
`success`	boolean	Always `true` on success
`data.id`	number	ID of the updated item

Response example

JSON

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

Error response example

400 — an empty request body: