Remove Attachments from Checklist Item tasks.template.checklist.removeAttachments
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to 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* |
Identifier of the task template. The identifier of the task template can be obtained when creating a new template |
|
checkListItemId* |
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* |
Array of attachment identifiers to be removed, for example An attachment identifier is a key of the The method skips identifiers that the item does not have without returning an error. The files are detached from the item but remain on Drive |
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
// 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.removeAttachments',
params: {
templateId: 139,
checkListItemId: 37,
attachmentsIds: [1119, 1121],
},
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('Updated checklist item:', 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 removeAttachments() {
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.removeAttachments',
params: {
templateId: 139,
checkListItemId: 37,
attachmentsIds: [1119, 1121],
},
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('Updated checklist item:', result.checkListItem)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', removeAttachments)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.tasks.template.checklist.remove_attachments(
template_id=139,
check_list_item_id=37,
attachments_ids=[
1119,
1121,
],
).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.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);
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "tasks.template.checklist.removeAttachments", b24.Params{
"templateId": 139,
"checkListItemId": 37,
"attachmentsIds": []int{1119, 1121},
})
if err != nil {
return fmt.Errorf("tasks.template.checklist.removeAttachments: %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"`
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("parse response: %w", err)
}
fmt.Println(item.ID, item.UserID)
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 |
Object with response data (detailed description) |
|
time |
Information about the request execution time |
Object result
|
Name |
Description |
|
checkListItem |
Checklist item after attachments removal (detailed description) |
Object checkListItem
|
Name |
Description |
|
id |
Identifier of the checklist item |
|
copiedId |
Identifier of the original item if the item was created by copying. For items created via REST, |
|
userId |
Identifier of the user who made the request |
|
createdBy |
Identifier of the item creator. Populated in the response of the |
|
parentId |
Identifier of the parent item. A value of |
|
title |
Text of the checklist item |
|
sortIndex |
Sorting index among items at the same level. The lower the value, the higher the item |
|
displaySortIndex |
Service field for display order. For template items, an empty string is returned |
|
isComplete |
Status of the item completion: |
|
isImportant |
Importance flag of the item: |
|
completedCount |
Service counter of completed subitems. For template items, |
|
members |
Array of objects with description of participants. If there are no participants, an empty array |
|
attachments |
Object with description of attachments. If there are no attachments, an empty array |
|
nodeId |
Service field. For template items, |
|
templateId |
Identifier of the task template |
Object members
The object structure depends on the method:
- the
tasks.template.checklist.addandtasks.template.checklist.updatemethods return participants in short form iffields.MEMBERSis passed in the request: onlyidof typeintegerandtype - in all other cases, the full set of fields from the table is returned, and
idis of typestring
|
Name |
Description |
|
Identifier of the user |
|
|
type |
Role of the user in the checklist item. Possible values:
|
|
name |
User's first and last name |
|
personalPhoto |
Identifier of the user's avatar file |
|
personalGender |
Gender of the user. Possible values:
|
|
image |
Link to the user's avatar |
|
isCollaber |
Indicator that the user is an external participant from a collab |
Object attachments
An object of the form { "attachment identifier": "n<file identifier>" }, for example {"621": "n10921"}.
|
Name |
Description |
|
key |
Identifier of the file attachment to the item. Pass it in the |
|
value |
Identifier of the file on Drive with the |
Error Handling
HTTP Status: 400
{
"error": "100",
"error_description": "Could not find value for parameter {templateId}"
}
|
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 |
|
|
|
Invalid value {abc} to match with parameter {templateId}. Should be value of type int. |
|
|
|
|
Invalid value {abc} to match with parameter {checkListItemId}. Should be value of type int. |
|
|
|
|
Access to task template was denied |
No permission to read the template, |
|
|
|
Could not find value for parameter |
Required parameter |
|
|
|
Invalid value {abc} to match with parameter {attachmentsIds}. Should be value of type array. |
|
|
|
|
Edit item: action unavailable |
No permission to modify 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 |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. 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
- Task Template Checklists: Overview of Methods
- Add Checklist Item to Task Template tasks.template.checklist.add
- 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
- Move Checklist Item After Another tasks.template.checklist.moveAfter
- Move Checklist Item Before Another 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