Move Folder to Trash disk.folder.markdeleted
Scope:
diskWho can execute the method: a user with "Full access" permission for the required folder
The method disk.folder.markdeleted moves a folder to the trash.
Save the folder ID after deletion so that it can be restored later using the method disk.folder.restore
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the folder. The identifier can be obtained using the method disk.folder.getchildren |
You cannot move the root folder of the storage to the trash.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":8996}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/disk.folder.markdeleted
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":8996,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/disk.folder.markdeleted
try
{
const response = await $b24.callMethod(
'disk.folder.markdeleted',
{
id: 8996,
}
);
const result = response.getData().result;
console.log('Folder marked as deleted with ID:', result);
processResult(result);
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'disk.folder.markdeleted',
[
'id' => 8996
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error marking folder as deleted: ' . $e->getMessage();
}
BX24.callMethod(
"disk.folder.markdeleted",
{
id: 8996
},
function (result)
{
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'disk.folder.markdeleted',
[
'id' => 8996
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"ID": "8996",
"NAME": "Folder",
"CODE": null,
"STORAGE_ID": "1357",
"TYPE": "folder",
"REAL_OBJECT_ID": "8996",
"PARENT_ID": "8907",
"DELETED_TYPE": 3,
"CREATE_TIME": "2026-01-21T13:53:51+02:00",
"UPDATE_TIME": "2026-01-21T13:53:51+02:00",
"DELETE_TIME": "2026-01-21T13:56:54+02:00",
"CREATED_BY": "1269",
"UPDATED_BY": "1269",
"DELETED_BY": "1269",
"DETAIL_URL": "https://test.bitrix24.com/company/personal/user/1269/disk/path/Folder/Folder"
},
"time": {
"start": 1768993014,
"finish": 1768993014.106899,
"duration": 0.10689902305603027,
"processing": 0,
"date_start": "2026-01-21T13:56:54+02:00",
"date_finish": "2026-01-21T13:56:54+02:00",
"operating_reset_at": 1768993614,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Array with data about the moved folder in the trash |
|
ID |
Identifier of the folder |
|
NAME |
Name of the folder |
|
CODE |
Symbolic code of the folder |
|
STORAGE_ID |
Identifier of the storage where the folder is located |
|
TYPE |
Type of the object |
|
REAL_OBJECT_ID |
Identifier of the object |
|
PARENT_ID |
Identifier of the parent folder |
|
DELETED_TYPE |
Deletion status of the object. Possible values:
|
|
CREATE_TIME |
Date and time of folder creation |
|
UPDATE_TIME |
Date and time of the last update of the folder |
|
DELETE_TIME |
Date and time of moving the folder to the trash |
|
CREATED_BY |
Identifier of the user who created the folder |
|
UPDATED_BY |
Identifier of the user who made the last change |
|
DELETED_BY |
Identifier of the user who deleted the folder |
|
DETAIL_URL |
Link to open the folder in the interface |
|
time |
Information about the execution time of the request |
Error Handling
HTTP Status: 400
{
"error":"ERROR_ARGUMENT",
"error_description":"Invalid value of parameter {Parameter #1}"
}
|
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
|
Code |
Description |
Value |
|
|
Invalid value of parameter |
Required parameter |
|
|
Could not delete root folder |
Attempt to move the root folder of the storage to the trash |
|
|
Could not find entity with id |
Folder with the specified |
|
|
Access denied |
Insufficient permissions to move the folder to the trash |
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 allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Create a Subfolder disk.folder.addsubfolder
- Copy a folder and all its contents to the specified folder disk.folder.copyto
- Permanently Delete a Folder and All Its Contents disk.folder.deletetree
- Get a list of files and folders in the folder disk.folder.getchildren
- Get Public Link for Folder disk.folder.getexternallink
- Get Folder Field Descriptions disk.folder.getfields
- Get Folder Parameters disk.folder.get
- Move a folder and all its contents to the specified folder disk.folder.moveto
- Rename Folder disk.folder.rename
- Restore Folder from Trash disk.folder.restore
- Assign Access Permissions to Folder disk.folder.sharetouser
- Upload a New File to the Specified Folder disk.folder.uploadfile