Delete Data Store entity.delete
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:
entityWho can execute the method: a user with
X(management) access permission on the data store
The entity.delete method removes the application's data store.
This method only works in the context of the application.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
ENTITY* |
Identifier of the application's data store. Use the value specified when creating the store. You can obtain the identifier using the entity.get method |
Code Examples
How to Use Examples in Documentation
Example of deleting a store where ENTITY is the identifier dish_v2.
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ENTITY":"dish_v2","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/entity.delete
try
{
const response = await $b24.callMethod(
'entity.delete',
{
ENTITY: 'dish_v2',
}
);
const result = response.getData().result;
console.info(result);
}
catch (error)
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'entity.delete',
[
'ENTITY' => 'dish_v2',
]
);
$result = $response
->getResponseData()
->getResult();
echo '<pre>';
print_r($result);
echo '</pre>';
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error deleting entity: ' . $e->getMessage();
}
BX24.callMethod(
'entity.delete',
{
ENTITY: 'dish_v2',
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'entity.delete',
[
'ENTITY' => 'dish_v2',
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": true,
"time": {
"start": 1774271103,
"finish": 1774271103.40342,
"duration": 0.40341997146606445,
"processing": 0,
"date_start": "2026-03-23T16:05:03+01:00",
"date_finish": "2026-03-23T16:05:03+01:00",
"operating_reset_at": 1774271703,
"operating": 0.13090085983276367
}
}
Returned Data
|
Name |
Description |
|
result |
The result of the method execution. Returns |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": "ERROR_ENTITY_NOT_FOUND",
"error_description": "Entity not found"
}
|
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 |
|
|
Argument 'ENTITY' is null or empty |
The |
|
|
Entity code is too long. Max length is N characters. |
The |
|
|
Entity not found |
The store with the provided |
|
|
Access denied! |
Insufficient permissions to delete the store |
|
|
Internal error deleting entity. Try deleting again. |
Internal error while deleting the store |
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
- Create a Data Storage entity.add
- Change Parameters of entity.update
- Get Storage Parameters or List of Storages entity.get
- Get or Modify Access Permissions for entity.rights