Добавить пункт чек-листа task.checklistitem.add

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: task

Кто может выполнять метод:

  • любой пользователь с доступом к редактированию задачи
  • постановщик, исполнитель и соисполнители задачи

Метод task.checklistitem.add добавляет новый пункт чек-листа в задаче.

Проверить права на добавление пункта можно методом task.checklistitem.isactionallowed.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

TASKID*
integer

Идентификатор задачи.

Идентификатор задачи можно получить при создании новой задачи или методом получения списка задач

FIELDS*
object

Объект с полями пункта чек-листа

Параметр FIELDS

Обязательные параметры отмечены *

Название
тип

Описание

TITLE*
string

Текст пункта чек-листа.

Если передать PARENT_ID со значением 0, то TITLE — название чек-листа

SORT_INDEX
integer

Индекс сортировки. Чем меньше значение, тем выше пункт в списке или подсписке

IS_COMPLETE
boolean

Статус выполнения пункта. Возможные значения:

  • Y — выполнен
  • N — не выполнен

По умолчанию — N

IS_IMPORTANT
boolean

Отметка, что пункт важный. Возможные значения:

  • Y — важный
  • N — обычный

MEMBERS
object

Объект с описанием участников пункта чек-листа. Ключ — идентификатор пользователя, значение — объект с параметром типа участника TYPE. Возможные значения типа участника:

  • 'TYPE': 'A' — соисполнитель
  • 'TYPE': 'U' — наблюдатель

Система добавит участников пункта чек-листа в задачу в тех же ролях

PARENT_ID
integer

Идентификатор родительского пункта. Используйте для вложенных чек-листов.

  • Если передать PARENT_ID со значением 0, система создаст в задаче новый чек-лист
  • Если в задаче нет пункта чек-листа с указанным PARENT_ID, система создаст новый чек-лист
  • Если не указать PARENT_ID в FIELDS, система добавит новый пункт в существующий верхний чек-лист. Если в задаче нет чек-листа, то создаст новый

Примеры кода

Как использовать примеры в документации

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"TASKID":13,"FIELDS":{"TITLE":"Подготовить отчет","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":"Подготовить отчет","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
        
// 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 ChecklistItemAddResult = number
        
        try {
          const response = await $b24.actions.v2.call.make<ChecklistItemAddResult>({
            method: 'task.checklistitem.add',
            params: {
              TASKID: 13,
              FIELDS: {
                TITLE: 'Prepare the report',
                PARENT_ID: 457,
                SORT_INDEX: 200,
                IS_COMPLETE: 'N',
                IS_IMPORTANT: 'Y',
                MEMBERS: {
                  547: {
                    TYPE: 'A',
                  },
                },
              },
            },
            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('Created checklist item with ID:', result)
          }
        } 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 addChecklistItem() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'task.checklistitem.add',
                params: {
                  TASKID: 13,
                  FIELDS: {
                    TITLE: 'Prepare the report',
                    PARENT_ID: 457,
                    SORT_INDEX: 200,
                    IS_COMPLETE: 'N',
                    IS_IMPORTANT: 'Y',
                    MEMBERS: {
                      547: {
                        TYPE: 'A',
                      },
                    },
                  },
                },
                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('Created checklist item with ID:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addChecklistItem)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'task.checklistitem.add',
                    [
                        'TASKID' => 13,
                        'FIELDS' => [
                            'TITLE' => 'Подготовить отчет',
                            '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': 'Подготовить отчет',
                    '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' => 'Подготовить отчет',
                    'PARENT_ID' => 457,
                    'SORT_INDEX' => 200,
                    'IS_COMPLETE' => 'N',
                    'IS_IMPORTANT' => 'Y',
                    'MEMBERS' => [
                        547 => [
                            'TYPE' => 'A'
                        ]
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Обработка ответа

HTTP-статус: 200

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

Возвращаемые данные

Название
тип

Описание

result
integer

Идентификатор нового пункта чек-листа

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
            "error":"ERROR_CORE",
            "error_description":"TASKS_ERROR_EXCEPTION_#8; Добавление элемента: действие недоступно; 8\/TE\/ACTION_FAILED_TO_BE_PROCESSED\u003Cbr\u003E"
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

Значение

ERROR_CORE

TASKS_ERROR_EXCEPTION_#8; Добавление элемента: действие недоступно; 8/TE/ACTION_FAILED_TO_BE_PROCESSED\u003Cbr\u003E

Нет доступа к задаче или недостаточно прав, чтобы работать с чек-листами в задаче

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

Не передан обязательный параметр TASKID или указан неверный тип значения для TASKID

ERROR_CORE

TASKS_ERROR_EXCEPTION_#256; Param #1 (arFields) expected by method ctaskchecklistitem::add(), but not given.; 256/TE/WRONG_ARGUMENTS\u003Cbr\u003E

Не передан обязательный параметр FIELDS или передан пустой

ERROR_CORE

TASKS_ERROR_EXCEPTION_#8; Не указано название элемента; 8/TE/ACTION_FAILED_TO_BE_PROCESSED\u003Cbr\u003E

Не передано обязательное поле TITLE в параметре FIELDS

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение