Обновить пункт чек-листа шаблона задачи tasks.template.checklist.update

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

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

Scope: task

Кто может выполнять метод: пользователь с правами на изменение шаблона задачи

Метод tasks.template.checklist.update обновляет пункт чек-листа шаблона задачи.

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

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

Название
тип

Описание

templateId*
integer

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

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

checkListItemId*
integer

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

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

fields*
object

Поля для обновления пункта чек-листа (подробное описание)

Параметр fields

Название
тип

Описание

TITLE
string

Текст пункта чек-листа. Пустая строка игнорируется, текст пункта не меняется.

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

PARENT_ID
integer

Идентификатор нового родительского пункта. Получить его можно методом tasks.template.checklist.list.

  • Если передать 0, пункт станет корневым — отдельным чек-листом шаблона
  • Пункт с указанным PARENT_ID должен быть в этом же шаблоне. Если его нет, метод вернет ошибку Изменение элемента: действие недоступно
  • Пункт переносится вместе со своими подпунктами с сохранением иерархии. Если перенести корневой пункт под пункт другого чек-листа, чек-листы объединятся в один

Чтобы поставить пункт рядом с конкретным пунктом, удобнее использовать методы tasks.template.checklist.moveAfter и tasks.template.checklist.moveBefore

SORT_INDEX
integer

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

IS_COMPLETE
boolean

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

  • Y или true — выполнен
  • N или false — не выполнен

Для смены статуса также можно использовать методы tasks.template.checklist.complete и tasks.template.checklist.renew

IS_IMPORTANT
boolean

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

  • Y или true — важный
  • N или false — обычный

MEMBERS
object

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

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

Поле MEMBERS заменяется полностью. Чтобы сохранить текущих участников, передайте их вместе с новыми значениями

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

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
  "templateId": 139,
  "checkListItemId": 37,
  "fields": {
    "TITLE": "4. Подготовить дашборд и отправить ссылку"
  }
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.template.checklist.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
  "templateId": 139,
  "checkListItemId": 37,
  "fields": {
    "TITLE": "4. Подготовить дашборд и отправить ссылку"
  },
  "auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/tasks.template.checklist.update
// 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 CheckListItemResult = {
  checkListItem: {
    id: number
    copiedId: number | null
    userId: number
    createdBy: number | null
    parentId: number
    title: string
    sortIndex: number
    displaySortIndex: string
    isComplete: boolean
    isImportant: boolean
    completedCount: number
    members: Array<{
      id: string
      type: string
      name: string
      personalPhoto: string
      personalGender: string
      image: string
      isCollaber: boolean
    }>
    // Key is the attachment id, value is the Disk file id with the "n" prefix; [] when there are no files
    attachments: Record<string, string> | []
    nodeId: number | null
    templateId: number
  }
}

try {
  const response = await $b24.actions.v2.call.make<CheckListItemResult>({
    method: 'tasks.template.checklist.update',
    params: {
      templateId: 139,
      checkListItemId: 37,
      fields: {
        TITLE: '4. Подготовить дашборд и отправить ссылку',
      },
    },
    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(result.checkListItem)
  }
} 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 updateChecklistItem() {
    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.update',
        params: {
          templateId: 139,
          checkListItemId: 37,
          fields: {
            TITLE: '4. Подготовить дашборд и отправить ссылку',
          },
        },
        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(result.checkListItem)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', updateChecklistItem)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

fields = {
    "TITLE": "4. Подготовить дашборд и отправить ссылку",
}

try:
    bitrix_response = client.tasks.template.checklist.update(
        template_id=139,
        check_list_item_id=37,
        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(
            'tasks.template.checklist.update',
            [
                'templateId' => 139,
                'checkListItemId' => 37,
                'fields' => [
                    'TITLE' => '4. Подготовить дашборд и отправить ссылку'
                ]
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}
BX24.callMethod(
    'tasks.template.checklist.update',
    {
        templateId: 139,
        checkListItemId: 37,
        fields: {
            TITLE: '4. Подготовить дашборд и отправить ссылку'
        }
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.log(result.data());
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'tasks.template.checklist.update',
    [
        'templateId' => 139,
        'checkListItemId' => 37,
        'fields' => [
            'TITLE' => '4. Подготовить дашборд и отправить ссылку'
        ]
    ]
);

print_r($result);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "tasks.template.checklist.update", b24.Params{
	"templateId":      139,
	"checkListItemId": 37,
	"fields": b24.Params{
		"TITLE": "4. Подготовить дашборд и отправить ссылку",
	},
})
if err != nil {
	return fmt.Errorf("tasks.template.checklist.update: %w", err)
}

// Метод заворачивает ответ в объект с ключом "checkListItem".
raw, ok := b24.Unwrap(res.Result, "checkListItem")
if !ok {
	return fmt.Errorf("в ответе нет ключа checkListItem")
}

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("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.UserID)

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

HTTP-статус: 200

{
    "result": {
        "checkListItem": {
            "id": 37,
            "copiedId": null,
            "userId": 503,
            "createdBy": null,
            "parentId": 23,
            "title": "4. Подготовить дашборд и отправить ссылку",
            "sortIndex": 3,
            "displaySortIndex": "",
            "isComplete": false,
            "isImportant": true,
            "completedCount": 0,
            "members": [
                {
                    "id": "547",
                    "type": "A",
                    "name": "Анна Петрова",
                    "personalPhoto": "57129",
                    "personalGender": "",
                    "image": "https://mysite.ru/b17053/resize_cache/57129/c0120a8d7c10d63c83e32398d1ec4d9e/main/137/137bfa78b877be117e75f1ac8652834a/anna.png",
                    "isCollaber": false
                }
            ],
            "attachments": [],
            "nodeId": null,
            "templateId": 139
        }
    },
    "time": {
        "start": 1773238088,
        "finish": 1773238088.917228,
        "duration": 0.9172279834747314,
        "processing": 0,
        "date_start": "2026-03-11T17:08:08+03:00",
        "date_finish": "2026-03-11T17:08:08+03:00",
        "operating_reset_at": 1773238688,
        "operating": 0
    }
}

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

Название
тип

Описание

result
object

Объект с данными ответа (подробное описание)

time
time

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

Объект result

Название
тип

Описание

checkListItem
object

Обновленный пункт чек-листа (подробное описание)

Объект checkListItem

Название
тип

Описание

id
integer

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

copiedId
integer

Идентификатор исходного пункта, если пункт создан копированием. Для пунктов, созданных через REST, возвращается null

userId
integer

Идентификатор пользователя, который выполнил запрос

createdBy
integer

Идентификатор автора пункта. Заполняется в ответе метода tasks.template.checklist.add, в ответах остальных методов возвращается null

parentId
integer

Идентификатор родительского пункта. Значение 0 означает корневой пункт — название чек-листа

title
string

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

sortIndex
integer

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

displaySortIndex
string

Служебное поле порядка отображения. Для пунктов шаблона возвращается пустая строка

isComplete
boolean

Статус выполнения пункта: true — выполнен, false — не выполнен

isImportant
boolean

Отметка важности пункта: true — важный, false — обычный

completedCount
integer

Служебный счетчик выполненных подпунктов. Для пунктов шаблона возвращается 0

members
array

Массив объектов с описанием участников.

Если участников нет, возвращается пустой массив []

attachments
object

Объект с описанием вложений.

Если вложений нет, возвращается пустой массив []

nodeId
integer

Служебное поле. Для пунктов шаблона возвращается null

templateId
integer

Идентификатор шаблона задачи

Объект members

Состав объекта зависит от метода:

  • методы tasks.template.checklist.add и tasks.template.checklist.update возвращают участников в краткой форме, если в запросе передан fields.MEMBERS: только id с типом integer и type
  • в остальных случаях возвращается полный набор полей из таблицы, id имеет тип string

Название
тип

Описание

id
string | integer

Идентификатор пользователя

type
string

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

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

name
string

Имя и фамилия пользователя

personalPhoto
string

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

personalGender
string

Пол пользователя. Возможные значения:

  • M — мужчина
  • F — женщина
  • пустая строка — не указан

image
string

Ссылка на аватар пользователя

isCollaber
boolean

Признак, что пользователь — внешний участник из коллабы

Объект attachments

Объект вида { "идентификатор прикрепления": "n<идентификатор файла>" }, например {"621": "n10921"}.

Название
тип

Описание

ключ
string

Идентификатор прикрепления файла к пункту. Передайте его в параметре attachmentsIds метода tasks.template.checklist.removeAttachments, чтобы удалить вложение

значение
string

Идентификатор файла на Диске с префиксом n. Тот же формат принимает параметр filesIds метода tasks.template.checklist.addAttachmentsFromDisk

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

HTTP-статус: 400

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

Название
тип

Описание

error
string

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

error_description
string

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

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

Статус

Код

Описание

Значение

400

100

Could not find value for parameter

Не передан обязательный параметр templateId

400

100

Could not find value for parameter

Не передан обязательный параметр checkListItemId

400

100

Invalid value {abc} to match with parameter {templateId}. Should be value of type int.

В templateId передано значение другого типа, а не число

400

100

Invalid value {abc} to match with parameter {checkListItemId}. Should be value of type int.

В checkListItemId передано значение другого типа, а не число

400

0

Доступ к шаблону задачи запрещен

Нет права на чтение шаблона, templateId меньше или равен 0, пункта checkListItemId нет в шаблоне или он удален

400

100

Could not find value for parameter

Не передан обязательный параметр fields

400

0

Не указаны поля для редактирования

Передан пустой fields

400

0

Изменение элемента: действие недоступно

Нет права на изменение шаблона задачи или в fields.PARENT_ID передан пункт, которого нет в шаблоне

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

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

403

FEATURE_NOT_AVAILABLE_ON_CURRENT_PLAN
Функция недоступна на текущем тарифе.

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

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

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

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