Add checklist item task.checklistitem.add

Scope: task

Who can execute the method:

any user with access to edit the task

creator, assignee, and participants of the task

The method task.checklistitem.add adds a new checklist item to a task.

You can check permissions for adding an item using the method task.checklistitem.isactionallowed.

Method Parameters

Required parameters are marked with *

Name
type

Description

TASKID*
integer

Task identifier.

The task identifier can be obtained when creating a new task or using the get task list method

FIELDS*
object

Object with checklist item fields

FIELDS Parameter

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
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 participant type parameter `TYPE`. Possible participant type values: `'TYPE': 'A'` — participant `'TYPE': 'U'` — observer The system will add checklist item participants to the task in the same roles
PARENT_ID `integer`	Identifier of the parent item. Use for nested checklists. If `PARENT_ID` is passed with a value of `0`, the system will create a new checklist in the task If there is no checklist item in the task with the specified `PARENT_ID`, the system will create a new checklist If `PARENT_ID` is not specified in `FIELDS`, the system will add a new item to the existing top-level checklist. If there is no checklist in the task, it will create a new one

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 '{"TASKID":13,"FIELDS":{"TITLE":"Prepare report","PARENT_ID":457,"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**/task.checklistitem.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"TASKID":13,"FIELDS":{"TITLE":"Prepare report","PARENT_ID":457,"SORT_INDEX":200,"IS_COMPLETE":"N","IS_IMPORTANT":"Y","MEMBERS":{"547":{"TYPE":"A"}}},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/task.checklistitem.add

try
        {
            const response = await $b24.callMethod(
                'task.checklistitem.add',
                {
                    TASKID: 13,
                    FIELDS: {
                        TITLE: 'Prepare report',
                        PARENT_ID: 457,
                        SORT_INDEX: 200,
                        IS_COMPLETE: 'N',
                        IS_IMPORTANT: 'Y',
                        MEMBERS: {
                            547: {
                                TYPE: 'A'
                            }
                        }
                    }
                }
            );
            
            const result = response.getData().result;
            console.log('Created checklist item with ID:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'task.checklistitem.add',
                    [
                        'TASKID' => 13,
                        'FIELDS' => [
                            'TITLE' => 'Prepare report',
                            'PARENT_ID' => 457,
                            'SORT_INDEX' => 200,
                            'IS_COMPLETE' => 'N',
                            'IS_IMPORTANT' => 'Y',
                            'MEMBERS' => [
                                547 => [
                                    'TYPE' => 'A'
                                ]
                            ]
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding checklist item: ' . $e->getMessage();
        }

BX24.callMethod(
            'task.checklistitem.add',
            {
                'TASKID': 13,
                'FIELDS': {
                    'TITLE': 'Prepare report',
                    'PARENT_ID': 457,
                    'SORT_INDEX': 200,
                    'IS_COMPLETE': 'N',
                    'IS_IMPORTANT': 'Y',
                    'MEMBERS': {
                        547: {
                            'TYPE': 'A'
                        }
                    }
                }
            },
            function(result){
                console.info(result.data());
                console.log(result);
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'task.checklistitem.add',
            [
                'TASKID' => 13,
                'FIELDS' => [
                    'TITLE' => 'Prepare report',
                    'PARENT_ID' => 457,
                    'SORT_INDEX' => 200,
                    'IS_COMPLETE' => 'N',
                    'IS_IMPORTANT' => 'Y',
                    'MEMBERS' => [
                        547 => [
                            'TYPE' => 'A'
                        ]
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": 475,
            "time": {
                "start": 1762431907,
                "finish": 1762431908.259832,
                "duration": 1.2598319053649902,
                "processing": 0,
                "date_start": "2025-11-06T15:25:07+02:00",
                "date_finish": "2025-11-06T15:25:08+02:00",
                "operating_reset_at": 1762432508,
                "operating": 0.24803590774536133
            }
        }

Returned Data

Name `type`	Description
result `integer`	Identifier of the new checklist item
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

{
            "error":"ERROR_CORE",
            "error_description":"TASKS_ERROR_EXCEPTION_#8; Adding item: action not allowed; 8/TE/ACTION_FAILED_TO_BE_PROCESSED<br>"
        }

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

Code	Description	Value
`ERROR_CORE`	TASKS_ERROR_EXCEPTION_#8; Adding item: action not allowed; 8/TE/ACTION_FAILED_TO_BE_PROCESSED	No access to the task or insufficient permissions to work with checklists in the task
`ERROR_CORE`	TASKS_ERROR_EXCEPTION_#256; Param #0 (taskId) for method ctaskchecklistitem::add() expected to be of type "integer", but given something else.; 256/TE/WRONG_ARGUMENTS	Required parameter `TASKID` not provided or incorrect type specified for `TASKID`
`ERROR_CORE`	TASKS_ERROR_EXCEPTION_#256; Param #1 (arFields) expected by method ctaskchecklistitem::add(), but not given.; 256/TE/WRONG_ARGUMENTS	Required parameter `FIELDS` not provided or empty
`ERROR_CORE`	TASKS_ERROR_EXCEPTION_#8; Item name not specified; 8/TE/ACTION_FAILED_TO_BE_PROCESSED	Required field `TITLE` not provided in the `FIELDS` parameter

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 task.checklistitem.add

Method ParametersMethod Parameters

FIELDS ParameterFIELDS Parameter

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning