Create Department humanresources.node.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:
humanresourcesWho can execute the method: a user with the "Add new departments" or "Add new teams" permission.
This method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.
The method humanresources.node.add creates a new department or team.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
type* |
The type of the structure element being created. Possible values:
|
|
name* |
The name of the department or team |
|
parentId* |
The identifier of the parent department or team. The identifier can be obtained using the humanresources.node.list method. |
|
description |
Description of the department or team |
|
colorName |
The color of the team. Possible values:
|
|
userIds |
Users to be added to the department or team. Description of the object structure User identifiers can be obtained using the user.get method. |
|
moveUsersToNode |
Determines whether to transfer users from Possible values:
Default: Use if |
|
createChat |
Determines whether to create a new chat for the department. Possible values:
Default: |
|
bindingChatIds |
An array of identifiers of existing chats to be linked to the department. Chat identifiers can be obtained using the im.recent.list method. |
|
createChannel |
Determines whether to create a new channel for the department. Possible values:
Default: |
|
bindingChannelIds |
An array of identifiers of existing channels to be linked to the department. Channel identifiers can be obtained using the im.recent.list method. |
|
createCollab |
Determines whether to create a new collaboration for the department if collaborations are available in the plan. Possible values:
Default: |
|
bindingCollabIds |
An array of identifiers of existing collaborations to be linked to the department. Collaboration identifiers can be obtained using the socialnetwork.api.workgroup.list method. |
|
settings |
Additional settings for the department or team. Description of the object structure |
Parameter userIds
|
Name |
Description |
|
MEMBER_HEAD |
Identifiers of department heads |
|
MEMBER_DEPUTY_HEAD |
Identifiers of deputy heads of the department |
|
MEMBER_EMPLOYEE |
Identifiers of department employees |
|
MEMBER_TEAM_HEAD |
Identifiers of team leaders |
|
MEMBER_TEAM_DEPUTY_HEAD |
Identifiers of deputy team leaders |
|
MEMBER_TEAM_EMPLOYEE |
Identifiers of team members |
Parameter settings
|
Name |
Description |
|
BUSINESS_PROC_AUTHORITY |
Roles allowed to work with the department or team workflows. Possible values:
|
|
REPORTS_AUTHORITY |
Roles allowed to work with the department or team reports. Possible values:
|
Code Examples
How to Use Examples in Documentation
The new API call differs by adding the /api/ segment to the request URL:
https://{installation_address}/rest/api/{user_id}/{webhook_token}/humanresources.node.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"type":"DEPARTMENT","name":"Marketing Department","parentId":1,"description":"Responsible for promotion","userIds":{"MEMBER_HEAD":[7],"MEMBER_EMPLOYEE":[12,15]},"moveUsersToNode":true,"createChat":true,"bindingChatIds":[31],"createChannel":false,"createCollab":false,"settings":{"BUSINESS_PROC_AUTHORITY":["HEAD","DEPUTY_HEAD"],"REPORTS_AUTHORITY":["HEAD"]}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/humanresources.node.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"type":"DEPARTMENT","name":"Marketing Department","parentId":1,"description":"Responsible for promotion","userIds":{"MEMBER_HEAD":[7],"MEMBER_EMPLOYEE":[12,15]},"moveUsersToNode":true,"createChat":true,"bindingChatIds":[31],"createChannel":false,"createCollab":false,"settings":{"BUSINESS_PROC_AUTHORITY":["HEAD","DEPUTY_HEAD"],"REPORTS_AUTHORITY":["HEAD"]},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/humanresources.node.add
// 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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type NodeAddResult = {
id: number
name: string
type: string
structureId: number
parentId: number
description: string | null
accessCode: string
userCount: number
colorName: string | null
xmlId: string | null
createdAt: ISODate
updatedAt: ISODate
members: Array<{
userId: number
name: string
workPosition: string
role: string
avatar: string | null
url: string
}>
}
try {
const response = await $b24.actions.v3.call.make<NodeAddResult>({
method: 'humanresources.node.add',
params: {
type: 'DEPARTMENT',
name: 'Marketing department',
parentId: 1,
description: 'Handles promotion',
userIds: {
MEMBER_HEAD: [7],
MEMBER_EMPLOYEE: [12, 15],
},
moveUsersToNode: true,
createChat: true,
bindingChatIds: [31],
settings: {
BUSINESS_PROC_AUTHORITY: ['HEAD', 'DEPUTY_HEAD'],
REPORTS_AUTHORITY: ['HEAD'],
},
},
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('Node created:', result.id, result.name, result.type)
}
} 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 addNode() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'humanresources.node.add',
params: {
type: 'DEPARTMENT',
name: 'Marketing department',
parentId: 1,
description: 'Handles promotion',
userIds: {
MEMBER_HEAD: [7],
MEMBER_EMPLOYEE: [12, 15],
},
moveUsersToNode: true,
createChat: true,
bindingChatIds: [31],
settings: {
BUSINESS_PROC_AUTHORITY: ['HEAD', 'DEPUTY_HEAD'],
REPORTS_AUTHORITY: ['HEAD'],
},
},
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('Node created:', result.id, result.name, result.type)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addNode)
</script>
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
try {
$response = $b24Service
->core
->call(
'humanresources.node.add',
[
'type' => 'DEPARTMENT',
'name' => 'Marketing Department',
'parentId' => 1,
'description' => 'Responsible for promotion',
'userIds' => [
'MEMBER_HEAD' => [7],
'MEMBER_EMPLOYEE' => [12, 15],
],
'moveUsersToNode' => true,
'createChat' => true,
'bindingChatIds' => [31],
'settings' => [
'BUSINESS_PROC_AUTHORITY' => ['HEAD', 'DEPUTY_HEAD'],
'REPORTS_AUTHORITY' => ['HEAD'],
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error creating department: ' . $e->getMessage();
}
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
BX24.callMethod(
'humanresources.node.add',
{
type: 'DEPARTMENT',
name: 'Marketing Department',
parentId: 1,
description: 'Responsible for promotion',
userIds: {
MEMBER_HEAD: [7],
MEMBER_EMPLOYEE: [12, 15]
},
moveUsersToNode: true,
createChat: true,
bindingChatIds: [31],
settings: {
BUSINESS_PROC_AUTHORITY: ['HEAD', 'DEPUTY_HEAD'],
REPORTS_AUTHORITY: ['HEAD']
}
},
function(result){
console.info(result.data());
console.log(result);
}
);
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via curl or fetch.
require_once('crest.php');
$result = CRest::call(
'humanresources.node.add',
[
'type' => 'DEPARTMENT',
'name' => 'Marketing Department',
'parentId' => 1,
'description' => 'Responsible for promotion',
'userIds' => [
'MEMBER_HEAD' => [7],
'MEMBER_EMPLOYEE' => [12, 15]
],
'moveUsersToNode' => true,
'createChat' => true,
'bindingChatIds' => [31],
'settings' => [
'BUSINESS_PROC_AUTHORITY' => ['HEAD', 'DEPUTY_HEAD'],
'REPORTS_AUTHORITY' => ['HEAD']
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"id": 44,
"name": "Marketing Department",
"type": "DEPARTMENT",
"structureId": 1,
"parentId": 1,
"description": "Responsible for promotion",
"accessCode": "DR44",
"userCount": 3,
"colorName": null,
"xmlId": null,
"createdAt": "2026-06-02T11:15:20+02:00",
"updatedAt": "2026-06-02T11:15:20+02:00",
"members": [
{
"userId": 7,
"name": "Anna Smith",
"workPosition": "Head of Marketing Department",
"role": "MEMBER_HEAD",
"avatar": "https://example.bitrix24.com/upload/main/1/avatar.jpg",
"url": "/company/personal/user/7/"
},
{
"userId": 12,
"name": "John Doe",
"workPosition": "Marketer",
"role": "MEMBER_EMPLOYEE",
"avatar": null,
"url": "/company/personal/user/12/"
}
]
},
"time": {
"start": 1780388120,
"finish": 1780388120.645321,
"duration": 0.6453211307525635,
"processing": 0.6032140254974365,
"date_start": "2026-06-02T11:15:20+02:00",
"date_finish": "2026-06-02T11:15:20+02:00",
"operating_reset_at": 1780388720,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object containing data of the created structure element |
|
id |
Identifier of the created department or team |
|
name |
Name of the department or team |
|
type |
Type of the structure element |
|
structureId |
Identifier of the company structure |
|
parentId |
Identifier of the parent department or team |
|
description |
Description of the department or team |
|
accessCode |
Access code of the structure element |
|
userCount |
Number of users in the department or team |
|
colorName |
Team color, if specified |
|
xmlId |
External identifier of the structure element |
|
createdAt |
Date and time of creation of the structure element |
|
updatedAt |
Date and time of the last update of the structure element |
|
members |
List of users added to the department or team with roles |
|
members[] |
User object of the department or team |
|
userId |
User identifier |
|
name |
User name |
|
workPosition |
User position |
|
role |
User role in the department or team |
|
avatar |
Link to the user's avatar |
|
url |
Link to the user's profile |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Error validating the request object",
"validation": [
{
"message": "Required field `name` is not specified",
"field": "name"
}
]
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
Description of the error related to the specified field |
Possible Error Codes
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Field |
Error Description |
How to Fix |
|
|
Required field |
Add the specified field to the request body |
|
|
Field |
Ensure the value passed is of the correct type |
|
|
An invalid value for the structure element type was provided |
Use |
|
|
Default company structure not found |
Ensure the company structure is created and accessible |
Access Errors
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Field |
Error Description |
How to Fix |
|
|
Access denied |
The user does not have permission to create a structure element in the specified parent department or team |
Error Code: BITRIX_REST_V3_EXCEPTION_INSUFFICIENTSCOPEEXCEPTION
|
Field |
Error Description |
How to Fix |
|
|
Insufficient permissions: required scope is missing |
Check the |
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 |