Create Department department.add
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:
departmentWho can execute the method: user with rights to modify the structure
The method department.add adds a new department to the company's structure.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
NAME* |
Department name |
|
SORT |
Department sorting field |
|
PARENT* |
Identifier of the parent department |
|
UF_HEAD |
Identifier of the user who will become the head of the department |
Code Examples
How to Use Examples in Documentation
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"NAME": "Muggle Studies Department",
"SORT": 450,
"UF_HEAD": 1,
"PARENT": 15
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/department.add
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"NAME": "Muggle Studies Department",
"SORT": 450,
"UF_HEAD": 1,
"PARENT": 15,
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/department.add
try
{
const response = await $b24.callMethod(
'department.add',
{
"NAME": "Muggle Studies Department",
"SORT": 450,
"UF_HEAD": 1,
"PARENT": 15
}
);
const result = response.getData().result;
console.log(result);
}
catch( error )
{
console.error(error.ex);
}
try {
$response = $b24Service
->core
->call(
'department.add',
[
'NAME' => 'Muggle Studies Department',
'SORT' => 450,
'UF_HEAD' => 1,
'PARENT' => 15,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error()->ex);
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding department: ' . $e->getMessage();
}
BX24.callMethod(
'department.add',
{
"NAME": "Muggle Studies Department",
"SORT": 450,
"UF_HEAD": 1,
"PARENT": 15
},
function(result)
{
if(result.error())
console.error(result.error().ex);
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'department.add',
[
'NAME' => 'Muggle Studies Department',
'SORT' => 450,
'UF_HEAD' => 1,
'PARENT' => 15,
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": 18,
"time": {
"start": 1736927311.779587,
"finish": 1736927312.132503,
"duration": 0.35291600227355957,
"processing": 0.17050600051879883,
"date_start": "2025-01-15T07:48:31+00:00",
"date_finish": "2025-01-15T07:48:32+00:00",
"operating": 0.1704881191253662
}
}
Returned Data
|
Name |
Description |
|
result |
Identifier of the created department |
|
time |
Information about the execution time of the request |
Error Handling
HTTP status: 400
{
"error": "ERROR_CORE",
"error_description": "Department name not provided.\u003Cbr\u003E"
}
|
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 name not provided.\u003Cbr\u003E |
Required parameter |
|
|
There can only be one top-level department in the company structure |
Incorrect |
|
|
Access denied |
Insufficient rights to add a 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 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
- Update Department department.update
- Get the list of departments department.get
- Delete department.department.delete
- Get a list of department field names department.fields