Add Checklist Item to Task Template tasks.template.checklist.add
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
taskWho can execute the method: a user with permissions to modify the task template
The method tasks.template.checklist.add adds a checklist item to the task template.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
templateId* |
Identifier of the task template. The identifier of the task template can be obtained when creating a new template |
|
fields* |
Fields of the created checklist item (detailed description) |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
TITLE* |
Text of the checklist item If |
|
PARENT_ID* |
Identifier of the parent item. To create a new checklist, pass If there is no checklist item in the template with the specified |
|
SORT_INDEX |
Sort index. The lower the value, the higher the item in the list or sublist |
|
IS_COMPLETE |
Status of the item. Possible values:
Default is |
|
IS_IMPORTANT |
Mark indicating that the item is important. Possible values:
|
|
MEMBERS |
Object describing the participants of the checklist item. Key — user identifier, value — object with the participant type parameter
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 -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"templateId": 139,
"fields": {
"TITLE": "4. Prepare the 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 the 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
// 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
parentId: number
title: string
sortIndex: number
displaySortIndex: string
isComplete: boolean
isImportant: boolean
completedCount: number
members: { type: string; id: number }[]
attachments: unknown[]
nodeId: number | null
templateId: number
}
}
try {
const response = await $b24.actions.v2.call.make<ChecklistItemResult>({
method: 'tasks.template.checklist.add',
params: {
templateId: 139,
fields: {
TITLE: '4. Prepare the dashboard',
PARENT_ID: 23,
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(result.checkListItem.id, result.checkListItem.title, result.checkListItem.isComplete)
}
} 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: 'tasks.template.checklist.add',
params: {
templateId: 139,
fields: {
TITLE: '4. Prepare the dashboard',
PARENT_ID: 23,
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(result.checkListItem.id, result.checkListItem.title, result.checkListItem.isComplete)
} 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": "4. Prepare the dashboard",
"PARENT_ID": 23,
"SORT_INDEX": 200,
"IS_COMPLETE": "N",
"IS_IMPORTANT": "Y",
"MEMBERS": {
547: {
"TYPE": "A",
},
},
}
try:
bitrix_response = client.tasks.template.checklist.add(
template_id=139,
fields=fields,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'tasks.template.checklist.add',
[
'templateId' => 139,
'fields' => [
'TITLE' => '4. Prepare the 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 the 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 the dashboard',
'PARENT_ID' => 23,
'SORT_INDEX' => 200,
'IS_COMPLETE' => 'N',
'IS_IMPORTANT' => 'Y',
'MEMBERS' => [
547 => [
'TYPE' => 'A'
]
],
]
]
);
print_r($result);
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "tasks.template.checklist.add", b24.Params{
"templateId": 139,
"fields": b24.Params{
"TITLE": "4. Prepare the dashboard",
"PARENT_ID": 23,
"SORT_INDEX": 200,
"IS_COMPLETE": "N",
"IS_IMPORTANT": "Y",
"MEMBERS": b24.Params{
"547": b24.Params{
"TYPE": "A",
},
},
},
})
if err != nil {
return fmt.Errorf("tasks.template.checklist.add: %w", err)
}
// The method wraps the response in an object with the "checkListItem" key.
raw, ok := b24.Unwrap(res.Result, "checkListItem")
if !ok {
return fmt.Errorf("no checkListItem key in the response")
}
var item struct {
ID b24.ID `json:"id"`
UserID b24.ID `json:"userId"`
CreatedBy int `json:"createdBy"`
ParentID b24.ID `json:"parentId"`
Title string `json:"title"`
SortIndex int `json:"sortIndex"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.UserID)
Response Handling
HTTP Status: 200
{
"result": {
"checkListItem": {
"id": 37,
"copiedId": null,
"userId": 503,
"createdBy": 503,
"parentId": 23,
"title": "4. Prepare the 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 |
Description |
|
result |
Object with response data (detailed description) |
|
time |
Information about the request execution time |
Object result
|
Name |
Description |
|
checkListItem |
Created checklist item (detailed description) |
Object checkListItem
|
Name |
Description |
|
id |
Identifier of the checklist item |
|
copiedId |
Identifier of the original item when copied, if applicable |
|
userId |
Identifier of the user in the context of which the object is created |
|
createdBy |
Identifier of the item creator |
|
parentId |
Identifier of the parent item. A value of |
|
title |
Text of the checklist item |
|
sortIndex |
Sorting index. The lower the value, the higher the item in the list or sublist |
|
displaySortIndex |
Auxiliary value for display order |
|
isComplete |
Status of the item completion |
|
isImportant |
Importance flag of the item |
|
completedCount |
Number of completions of the item |
|
members |
Array of objects with description of participants. If there is no data, an empty array |
|
attachments |
Object with description of attachments. If there is no data, an empty array |
|
nodeId |
Service identifier of the node, if used |
|
templateId |
Identifier of the task template |
Object members
|
Name |
Description |
|
id |
Identifier of the user |
|
type |
Role of the user in the checklist item. Possible values:
|
|
name |
User's name |
|
personalPhoto |
Identifier of the user's avatar file on Drive |
|
personalGender |
Gender of the user. Possible values:
|
|
image |
Link to the user's avatar |
|
isCollaber |
Indicator that the user is an external participant |
Object attachments
|
Name |
Description |
|
attachmentId |
Identifier of the file on Drive in the format |
Error Handling
HTTP Status: 400
{
"error": "0",
"error_description": "Invalid value [] for field [PARENT_ID] in element [, New item]"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Could not find value for parameter |
Required parameter |
|
|
|
Could not find value for parameter |
Required parameter |
|
|
|
Item name is not specified |
Required parameter |
|
|
|
Invalid value [] for field [PARENT_ID] in element [, Item name] |
Required parameter |
|
|
|
Adding item: action is not available |
User does not have permission to add a checklist item to the task template |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Update Checklist Item of Task Template tasks.template.checklist.update
- Get Checklist Item from Task Template tasks.template.checklist.get
- Get the List of Checklist Items for Task Template tasks.template.checklist.list
- Delete Checklist Item from Task Template tasks.template.checklist.delete
- Complete Checklist Item of Task Template tasks.template.checklist.complete