#Обновить узел

PATCH /v1/humanresources/nodes/:id

Изменяет узел организационной структуры портала Битрикс24 — отдел или команду в дереве подразделений. В теле передаются только изменяемые поля плоско в корне JSON без обёртки fields.

#Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор узла. Список: GET /v1/humanresources/nodes

#Поля запроса (body)

Поле Тип Обяз. Описание
name string нет Название узла
description string нет Описание узла
parentId number нет Идентификатор родительского узла. Список: GET /v1/humanresources/nodes
colorName string нет Код цвета узла, например blue или AZURE
type string нет Тип узла: DEPARTMENT или TEAM

#Примеры

#curl — личный ключ

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/humanresources/nodes/39" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Отдел продаж",
    "description": "Обновлённое описание"
  }'

#curl — OAuth-приложение

Terminal 
curl -X PATCH "https://vibecode.bitrix24.tech/v1/humanresources/nodes/39" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Отдел продаж",
    "description": "Обновлённое описание"
  }'

#JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/humanresources/nodes/39', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Отдел продаж',
    description: 'Обновлённое описание',
  }),
})

const { success, data } = await res.json()
console.log('Обновлён узел:', data.id)

#JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/humanresources/nodes/39', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Отдел продаж',
    description: 'Обновлённое описание',
  }),
})

const { success, data } = await res.json()

#Поля ответа

Возвращается полная запись узла после изменения.

Поле Тип Описание
id number Идентификатор узла
name string Название узла
type string Тип узла: DEPARTMENT или TEAM
structureId number Идентификатор структуры, к которой относится узел
parentId number Идентификатор родительского узла
description string Описание узла
accessCode string Код доступа узла
userCount number Количество сотрудников в узле
colorName string Цвет узла
xmlId string Внешний идентификатор узла
createdAt datetime Дата создания. В ответе на изменение приходит как null
updatedAt datetime Дата последнего изменения. В ответе на изменение приходит как null
members array Список участников узла

#Пример ответа

JSON 
{
  "success": true,
  "data": {
    "id": 39,
    "name": "Отдел продаж",
    "type": "DEPARTMENT",
    "structureId": 1,
    "parentId": 17,
    "description": "Обновлённое описание",
    "accessCode": "SN39",
    "userCount": 0,
    "colorName": "blue",
    "xmlId": null,
    "createdAt": null,
    "updatedAt": null,
    "members": []
  }
}

#Пример ответа при ошибке

404 — узел с указанным id не найден:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Запись с ID = `0` не найдена"
  }
}

#Ошибки

HTTP Код Описание
404 ENTITY_NOT_FOUND Узла с указанным id не существует
400 INVALID_PARAMS Нарушена валидация переданных полей
403 SCOPE_DENIED Ключу не хватает скоупа humanresources
401 TOKEN_MISSING У API-ключа не настроены токены Битрикс24

Полный список общих ошибок API — Ошибки.

#Известные особенности

Даты в ответе на изменение. Поля createdAt и updatedAt в ответе на изменение приходят как null. Чтобы получить актуальные даты, запросите узел через `GET /v1/humanresources/nodes/:id`.

#Смотрите также