Update Department humanresources.node.edit
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 "Edit Departments" or "Edit Teams" access 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.edit updates the properties of a department or team.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the department or team. The identifier can be obtained using the humanresources.node.list method. |
|
name |
New name of the department or team. |
|
description |
New description of the department or team. |
|
colorName |
New color of the team. Possible values:
|
Please provide at least one field to change: name, description, or colorName.
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.edit
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":44,"name":"B2B Sales Department","description":"Works with corporate clients"}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/humanresources.node.edit
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":44,"name":"B2B Sales Department","description":"Works with corporate clients","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/humanresources.node.edit
// 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 NodeEditResult = {
id: number
name: string
type: string
structureId: number
parentId: number
description: string
accessCode: string
userCount: number
colorName: string | null
xmlId: string | null
createdAt: ISODate | null
updatedAt: ISODate | null
}
try {
const response = await $b24.actions.v3.call.make<NodeEditResult>({
method: 'humanresources.node.edit',
params: {
id: 44,
name: 'B2B Sales Department',
description: 'Works with corporate clients',
},
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('Updated node:', 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 editNode() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'humanresources.node.edit',
params: {
id: 44,
name: 'B2B Sales Department',
description: 'Works with corporate clients',
},
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('Updated node:', result.id, result.name, result.type)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', editNode)
</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.edit',
[
'id' => 44,
'name' => 'B2B Sales Department',
'description' => 'Works with corporate clients',
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating 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.edit',
{
id: 44,
name: 'B2B Sales Department',
description: 'Works with corporate clients'
},
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.edit',
[
'id' => 44,
'name' => 'B2B Sales Department',
'description' => 'Works with corporate clients'
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"id": 44,
"name": "B2B Sales Department",
"type": "DEPARTMENT",
"structureId": 1,
"parentId": 1,
"description": "Works with corporate clients",
"accessCode": "DR44",
"userCount": 18,
"colorName": null,
"xmlId": null,
"createdAt": "2026-05-30T09:20:15+02:00",
"updatedAt": "2026-06-02T12:40:18+02:00"
},
"time": {
"start": 1780393218,
"finish": 1780393218.504217,
"duration": 0.5042169094085693,
"processing": 0.47100210189819336,
"date_start": "2026-06-02T12:40:18+02:00",
"date_finish": "2026-06-02T12:40:18+02:00",
"operating_reset_at": 1780393818,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object with data of the updated department or team. |
|
id |
Identifier of the 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 department or team. |
|
userCount |
Number of users in the department or team. |
|
colorName |
Color of the team, if specified. |
|
xmlId |
External identifier of the department or team. |
|
createdAt |
Date and time of creation of the department or team. |
|
updatedAt |
Date and time of the last update of the department or team. |
|
time |
Information about the execution time of the request. |
Error Handling
HTTP Status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Error validating the request object",
"validation": [
{
"message": "At least one of the following fields must be provided: name, description, colorName.",
"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 |
|
|
Field |
Ensure that the value of |
|
|
At least one field must be provided for modification. |
Provide |
|
|
An invalid color value was provided. |
Use one of the valid values from the |
Access Errors
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Field |
Error Description |
How to Fix |
|
|
Access denied. |
The user does not have permission to edit the specified department or team. |
Error Code: BITRIX_REST_V3_EXCEPTION_INSUFFICIENTSCOPEEXCEPTION
|
Field |
Error Description |
How to Fix |
|
|
Insufficient access rights: 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 |