Remove Attachments from Checklist Item tasks.template.checklist.removeAttachments
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.removeAttachments removes attachments from a checklist item in the task template.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
templateId* |
The identifier of the task template. The identifier of the task template can be obtained when creating a new template |
|
checkListItemId* |
The identifier of the checklist item. The identifier of the checklist item can be obtained when creating a new item or by using the method to get the list of items |
|
attachmentsIds* |
An array of attachment identifiers to be removed |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"templateId": 139,
"checkListItemId": 37,
"attachmentsIds": [
1119,
1121
]
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.template.checklist.removeAttachments
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"templateId": 139,
"checkListItemId": 37,
"attachmentsIds": [
1119,
1121
],
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/tasks.template.checklist.removeAttachments
try
{
const response = await $b24.callMethod(
'tasks.template.checklist.removeAttachments',
{
templateId: 139,
checkListItemId: 37,
attachmentsIds: [1119, 1121]
}
);
const result = response.getData().result;
console.log(result);
}
catch (error)
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'tasks.template.checklist.removeAttachments',
[
'templateId' => 139,
'checkListItemId' => 37,
'attachmentsIds' => [1119, 1121]
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'tasks.template.checklist.removeAttachments',
{
templateId: 139,
checkListItemId: 37,
attachmentsIds: [1119, 1121]
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'tasks.template.checklist.removeAttachments',
[
'templateId' => 139,
'checkListItemId' => 37,
'attachmentsIds' => [1119, 1121]
]
);
print_r($result);
Response Handling
HTTP Status: 200
{
"result": {
"checkListItem": {
"id": 37,
"copiedId": null,
"userId": 503,
"createdBy": null,
"parentId": 23,
"title": "4. Prepare the dashboard and send the link",
"sortIndex": 2,
"displaySortIndex": "",
"isComplete": false,
"isImportant": true,
"completedCount": 0,
"members": [
{
"id": "547",
"type": "A",
"name": "Anna Peterson",
"personalPhoto": "57129",
"personalGender": "",
"image": "https://mysite.com/b17053/resize_cache/57129/c0120a8d7c10d63c83e32398d1ec4d9e/main/137/137bfa78b877be117e75f1ac8652834a/anna.png",
"isCollaber": false
}
],
"attachments": [],
"nodeId": null,
"templateId": 139
}
},
"time": {
"start": 1773298408,
"finish": 1773298408.806751,
"duration": 0.806751012802124,
"processing": 0,
"date_start": "2026-03-12T09:53:28+01:00",
"date_finish": "2026-03-12T09:53:28+01:00",
"operating_reset_at": 1773299008,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
An object containing the response data (detailed description) |
|
time |
Information about the request execution time |
Object result
|
Name |
Description |
|
checkListItem |
The checklist item after the attachments have been removed (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": "100",
"error_description": "Could not find value for parameter {templateId}"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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
|
Status |
Code |
Description |
Value |
|
|
|
Could not find value for parameter |
Required parameter |
|
|
|
Bitrix\Tasks\CheckList\Internals\CheckList All parameters in the constructor must have real class type |
Required parameter |
|
|
|
Could not find value for parameter |
Required parameter |
|
|
|
Invalid value {} to match with parameter {attachmentsIds}. Should be value of type array. |
Empty or invalid type for |
|
|
|
Incorrect value [] specified for field [ENTITY_ID] in element [, ] |
Non-existent, empty, or invalid type for |
|
|
|
Changing the item: action not available |
User does not have permission to modify the task template |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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
- Add Checklist Item to Task Template tasks.template.checklist.add
- Update Checklist Item of Task Template tasks.template.checklist.update
- Get Checklist Item of 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
- Move Checklist Item After Another tasks.template.checklist.moveAfter
- Move Checklist Item Before Another Item: `tasks.template.checklist.moveBefore`
- Complete Checklist Item of Task Template tasks.template.checklist.complete
- Renew Checklist Item of Task Template tasks.template.checklist.renew
- Add Attachment to Checklist Item Using tasks.template.checklist.addAttachmentByContent
- Add Attachments from Drive to Checklist Item tasks.template.checklist.addAttachmentsFromDisk