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

Reopen an item

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

Clears the completion status of a checklist item. Equivalent to PATCH with the body { "isComplete": false }, but doesn't require passing the other fields.

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

No request body is required.

Examples

curl — personal key

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

curl — OAuth application

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

JavaScript — personal key

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

JavaScript — OAuth application

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

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata.id Typenumber DescriptionItem ID
Fielddata.isComplete Typestring DescriptionAlways "N" after a successful call

Response example

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

Error response example

400 — invalid itemId:

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

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptiontaskId or itemId is not a positive integer
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 itemId and a nonexistent taskId both return 200. The response echoes the given itemId with isComplete: "N" even when no such item exists — and even when the task itself is missing. A success status confirms neither that the item exists nor that it was reopened. To check whether the item exists, call "Get an item", which returns 404 both for a missing item and for a missing task.
  • A missing-item error has not been observed for this method. The route maps a Bitrix24 "item not found" error to 404 NOT_FOUND, as the other checklist methods do, but on a live Bitrix24 account this method never returned that error — the probe returned 200, and the tests reproduce the error only with a mock. That is why 404 is not listed in the errors above.

See also