Add Checklist Item to Task Template tasks.template.checklist.add

Scope: task

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

The method tasks.template.checklist.add adds a checklist item to a task template.

Method Parameters

Required parameters are marked with *

Name
type

Description

templateId*
integer

Identifier of the task template.

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

fields*
object

Fields of the checklist item being created (detailed description)

Parameter fields

Required parameters are marked with *

Name `type`	Description
TITLE* `string`	Text of the checklist item If `PARENT_ID` is passed with a value of `0`, then `TITLE` is the name of the checklist
PARENT_ID* `integer`	Identifier of the parent item. To create a new checklist, pass `PARENT_ID` with a value of `0`. If there is no checklist item in the template with the specified `PARENT_ID`, the system will create a new checklist
SORT_INDEX `integer`	Sort index. The lower the value, the higher the item in the list or sublist
IS_COMPLETE `boolean`	Status of the item. Possible values: `Y` — completed `N` — not completed Default is `N`
IS_IMPORTANT `boolean`	Mark indicating that the item is important. Possible values: `Y` — important `N` — regular
MEMBERS `object`	Object describing the participants of the checklist item. Key — user identifier, value — object with the participant type parameter `TYPE`. Possible participant type values: `'TYPE': 'A'` — Participant `'TYPE': 'U'` — Observer The system will add the participants of the checklist item to the task in the same roles

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
          "templateId": 139,
          "fields": {
            "TITLE": "4. Prepare Dashboard",
            "PARENT_ID": 23,
            "SORT_INDEX": 200,
            "IS_COMPLETE": "N",
            "IS_IMPORTANT": "Y",
            "MEMBERS": {
              "547": {
                "TYPE": "A"
              }
            }
          }
        }' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.template.checklist.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
          "templateId": 139,
          "fields": {
            "TITLE": "4. Prepare Dashboard",
            "PARENT_ID": 23,
            "SORT_INDEX": 200,
            "IS_COMPLETE": "N",
            "IS_IMPORTANT": "Y",
            "MEMBERS": {
              "547": {
                "TYPE": "A"
              }
            }
          },
          "auth": "**put_access_token_here**"
        }' \
        https://**put_your_bitrix24_address**/rest/tasks.template.checklist.add

try
        {
            const response = await $b24.callMethod(
                'tasks.template.checklist.add',
                {
                    templateId: 139,
                    fields: {
                        TITLE: '4. Prepare Dashboard',
                        PARENT_ID: 23,
                        SORT_INDEX: 200,
                        IS_COMPLETE: 'N',
                        IS_IMPORTANT: 'Y',
                        MEMBERS: {
                            547: {
                                TYPE: 'A'
                            }
                        }
                    }
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'tasks.template.checklist.add',
                    [
                        'templateId' => 139,
                        'fields' => [
                            'TITLE' => '4. Prepare Dashboard',
                            'PARENT_ID' => 23,
                            'SORT_INDEX' => 200,
                            'IS_COMPLETE' => 'N',
                            'IS_IMPORTANT' => 'Y',
                            'MEMBERS' => [
                                547 => [
                                    'TYPE' => 'A'
                                ]
                            ]
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            'tasks.template.checklist.add',
            {
                templateId: 139,
                fields: {
                    TITLE: '4. Prepare Dashboard',
                    PARENT_ID: 23,
                    SORT_INDEX: 200,
                    IS_COMPLETE: 'N',
                    IS_IMPORTANT: 'Y',
                    MEMBERS: {
                        547: {
                            TYPE: 'A'
                        }
                    }
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'tasks.template.checklist.add',
            [
                'templateId' => 139,
                'fields' => [
                    'TITLE' => '4. Prepare Dashboard',
                    'PARENT_ID' => 23,
                    'SORT_INDEX' => 200,
                    'IS_COMPLETE' => 'N',
                    'IS_IMPORTANT' => 'Y',
                    'MEMBERS' => [
                        547 => [
                            'TYPE' => 'A'
                        ]
                    ],
                ]
            ]
        );
        
        print_r($result);

Response Handling

HTTP Status: 200

{
            "result": {
                "checkListItem": {
                    "id": 37,
                    "copiedId": null,
                    "userId": 503,
                    "createdBy": 503,
                    "parentId": 23,
                    "title": "4. Prepare Dashboard",
                    "sortIndex": 200,
                    "displaySortIndex": "",
                    "isComplete": false,
                    "isImportant": true,
                    "completedCount": 0,
                    "members": [
                        {
                            "type": "A",
                            "id": 547
                        }
                    ],
                    "attachments": [],
                    "nodeId": null,
                    "templateId": 139
                }
            },
            "time": {
                "start": 1773235651,
                "finish": 1773235651.960878,
                "duration": 0.9608778953552246,
                "processing": 0,
                "date_start": "2026-03-11T16:27:31+01:00",
                "date_finish": "2026-03-11T16:27:31+01:00",
                "operating_reset_at": 1773236251,
                "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`	Created checklist item (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 was 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 appears in the list or sublist
displaySortIndex `string`	Auxiliary value for display order
isComplete `boolean`	Status of item completion
isImportant `boolean`	Importance flag for the item
completedCount `integer`	Number of completions for 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`	User's role 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`	User's gender. 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
`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": "0",
            "error_description": "Invalid value [] for field [PARENT_ID] in item [, New item]"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Status	Code	Description	Value
`400`	`100`	Could not find value for parameter	Required parameter `templateId` not provided
`400`	`100`	Could not find value for parameter	Required parameter `fields` not provided
`400`	`0`	Item name not specified	Required parameter `fields.TITLE` not provided or invalid value passed
`400`	`0`	Invalid value [] for field [PARENT_ID] in item [, Item name]	Required parameter `fields.PARENT_ID` not provided or invalid value passed
`400`	`0`	Adding item: action not available	User does not have permission to add checklist item in the task template

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Overview of Methods

Update Checklist Item

Add Checklist Item to Task Template tasks.template.checklist.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Object resultObject result

Object checkListItemObject checkListItem

Object membersObject members

Object attachmentsObject attachments

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning