Delete department.department.delete
Scope:
departmentWho can execute the method: user with rights to modify the structure
The method department.delete removes a department from the company structure.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
ID* |
Identifier of the department |
Code Examples
How to Use Examples in Documentation
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":18}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/department.delete
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":18,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/department.delete
try
{
const response = await $b24.callMethod(
"department.delete", {
"ID": 18
}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'department.delete',
[
'ID' => 18
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Your logic for processing data
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error deleting department: ' . $e->getMessage();
}
BX24.callMethod(
"department.delete", {
"ID": 18
},
function(result) {
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'department.delete',
[
'ID' => 18
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": true,
"time": {
"start": 1736929002.119324,
"finish": 1736929002.469626,
"duration": 0.35030198097229004,
"processing": 0.13488411903381348,
"date_start": "2025-01-15T08:16:42+00:00",
"date_finish": "2025-01-15T08:16:42+00:00",
"operating": 0.13484978675842285
}
}
Returned Data
|
Name |
Description |
|
result |
Result of the department deletion in the company structure |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error":"ERROR_CORE",
"error_description":"Department 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 |
Error Message |
Description |
|
|
Department not found |
The department to be deleted was not found |
|
|
Access denied |
Insufficient rights to delete the department |
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 Department department.add
- Update Department department.update
- Get the list of departments department.get
- Get a list of department field names department.fields