Добавить пункт чек-листа 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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

fields = {
    "TITLE": "Подготовить отчет",
    "PARENT_ID": 457,
    "SORT_INDEX": 200,
    "IS_COMPLETE": "N",
    "IS_IMPORTANT": "Y",
    "MEMBERS": {
        "547": {
            "TYPE": "A",
        },
    },
}

try:
    bitrix_response = client.task.checklistitem.add(
        task_id=13,
        fields=fields,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "task.checklistitem.add", b24.Params{
	"TASKID": 13,
	"FIELDS": b24.Params{
		"TITLE":        "Подготовить отчет",
		"PARENT_ID":    457,
		"SORT_INDEX":   200,
		"IS_COMPLETE":  "N",
		"IS_IMPORTANT": "Y",
		"MEMBERS": b24.Params{
			"547": b24.Params{
				"TYPE": "A",
			},
		},
	},
})
if err != nil {
	return fmt.Errorf("task.checklistitem.add: %w", err)
}

var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("идентификатор:", newID)

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

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
string

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

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

Код

Описание

Значение

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-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

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

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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