Complete Checklist Item of Task Template tasks.template.checklist.complete

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: task

Who can execute the method: a user with permissions to modify the task template

The method tasks.template.checklist.complete marks a checklist item of the template as completed.

Method Parameters

Required parameters are marked with *

Name
type

Description

templateId*
integer

Identifier of the task template.

The identifier of the task template can be obtained when creating a new template

checkListItemId*
integer

Identifier of the checklist item.

The identifier of the checklist item can be obtained when creating a new item or by using the method to get the list of items

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
          "templateId": 139,
          "checkListItemId": 27
        }' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.template.checklist.complete
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
          "templateId": 139,
          "checkListItemId": 27,
          "auth": "**put_access_token_here**"
        }' \
        https://**put_your_bitrix24_address**/rest/tasks.template.checklist.complete
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type CompleteCheckListItemResult = {
          checkListItem: {
            id: number
            copiedId: number | null
            userId: number
            createdBy: number | null
            parentId: number | null
            title: string
            sortIndex: number
            displaySortIndex: string
            isComplete: boolean
            isImportant: boolean
            completedCount: number
            members: unknown[]
            attachments: unknown[]
            nodeId: number | null
            templateId: number
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<CompleteCheckListItemResult>({
            method: 'tasks.template.checklist.complete',
            params: {
              templateId: 139,
              checkListItemId: 27,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Checklist item', result.checkListItem.id, 'completed:', result.checkListItem.isComplete)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function completeCheckListItem() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'tasks.template.checklist.complete',
                params: {
                  templateId: 139,
                  checkListItemId: 27,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Checklist item', result.checkListItem.id, 'completed:', result.checkListItem.isComplete)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', completeCheckListItem)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.tasks.template.checklist.complete(
                template_id=139,
                check_list_item_id=27,
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'tasks.template.checklist.complete',
                    [
                        'templateId' => 139,
                        'checkListItemId' => 27
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        
BX24.callMethod(
            'tasks.template.checklist.complete',
            {
                templateId: 139,
                checkListItemId: 27
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'tasks.template.checklist.complete',
            [
                'templateId' => 139,
                'checkListItemId' => 27
            ]
        );
        
        print_r($result);
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "tasks.template.checklist.complete", b24.Params{
        	"templateId":      139,
        	"checkListItemId": 27,
        })
        if err != nil {
        	return fmt.Errorf("tasks.template.checklist.complete: %w", err)
        }
        
        // The method wraps the response in an object with the "checkListItem" key.
        raw, ok := b24.Unwrap(res.Result, "checkListItem")
        if !ok {
        	return fmt.Errorf("no checkListItem key in the response")
        }
        
        var item struct {
        	ID               b24.ID `json:"id"`
        	UserID           b24.ID `json:"userId"`
        	ParentID         b24.ID `json:"parentId"`
        	Title            string `json:"title"`
        	SortIndex        int    `json:"sortIndex"`
        	DisplaySortIndex string `json:"displaySortIndex"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.UserID)
        

Response Handling

HTTP Status: 200

{
            "result": {
                "checkListItem": {
                    "id": 27,
                    "copiedId": null,
                    "userId": 503,
                    "createdBy": null,
                    "parentId": 23,
                    "title": "2. Fill out the report form",
                    "sortIndex": 1,
                    "displaySortIndex": "",
                    "isComplete": true,
                    "isImportant": false,
                    "completedCount": 0,
                    "members": [],
                    "attachments": [],
                    "nodeId": null,
                    "templateId": 139
                }
            },
            "time": {
                "start": 1773239663,
                "finish": 1773239663.724766,
                "duration": 0.7247660160064697,
                "processing": 0,
                "date_start": "2026-03-11T17:34:23+01:00",
                "date_finish": "2026-03-11T17:34:23+01:00",
                "operating_reset_at": 1773240263,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Object with response data (detailed description)

time
time

Information about the request execution time

Object result

Name
type

Description

checkListItem
object

Updated checklist item after completion (detailed description)

Object checkListItem

Name
type

Description

id
integer

Identifier of the checklist item

copiedId
integer

Identifier of the original item when copied, if applicable

userId
integer

Identifier of the user in the context of which the object is created

createdBy
integer

Identifier of the item creator

parentId
integer

Identifier of the parent item. A value of 0 indicates a root item

title
string

Text of the checklist item

sortIndex
integer

Sorting index. The lower the value, the higher the item in the list or sublist

displaySortIndex
string

Auxiliary value for display order

isComplete
boolean

Status of the item completion

isImportant
boolean

Importance flag of the item

completedCount
integer

Number of completions of the item

members
array

Array of objects with description of participants.

If there is no data, an empty array [] is returned

attachments
object

Object with description of attachments.

If there is no data, an empty array [] is returned

nodeId
integer

Service identifier of the node, if used

templateId
integer

Identifier of the task template

Object members

Name
type

Description

id
string

Identifier of the user

type
string

Role of the user in the checklist item. Possible values:

  • A — Participant
  • U — Observer

name
string

User's name

personalPhoto
string

Identifier of the user's avatar file on Drive

personalGender
string

Gender of the user. Possible values:

  • M — Male
  • F — Female

image
string

Link to the user's avatar

isCollaber
boolean

Indicator that the user is an external participant

Object attachments

Name
type

Description

attachmentId
string

Identifier of the file on Drive in the format n<fileId>, where the key is the identifier of the attachment

Error Handling

HTTP Status: 400

{
            "error": "100",
            "error_description": "Could not find value for parameter {templateId}"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status

Code

Description

Value

400

100

Could not find value for parameter

Required parameter templateId is missing

400

100

Bitrix\Tasks\CheckList\Internals\CheckList All parameters in the constructor must have real class type

Required parameter checkListItemId is missing

400

0

Bitrix\Tasks\CheckList\CheckListFacade::onAfterUpdate(): Argument #1 ($taskId) must be of type int, string given, called in /var/www/html/bitrix/modules/tasks/lib/checklist/checklistfacade.php on line 313

Empty or incorrect type for templateId

400

0

Incorrect value [] for field [ENTITY_ID] in item [, ]

Non-existent, empty, or incorrect type for checkListItemId

400

0

Changing the status of the item: action unavailable

User does not have permission to modify the task template

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

The REST API is available only on commercial plans. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning