#Добавить участников

POST /v1/humanresources/nodes/:id/members/add

Добавляет одного или нескольких сотрудников в узел организационной структуры с указанной ролью. За один вызов можно добавить сразу несколько участников — все получают одну и ту же роль.

#Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор узла, в который добавляются участники. Список идентификаторов: GET /v1/humanresources/nodes?type=DEPARTMENT

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

Поле Тип Обяз. Описание
userIds array да Идентификаторы сотрудников. Поиск: POST /v1/humanresources/employees/search
role string да Роль, назначаемая всем добавляемым сотрудникам. Набор ролей зависит от типа узла. Доступные роли — Участники узлов

#Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/humanresources/nodes/23/members/add" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "userIds": [42, 108], "role": "MEMBER_EMPLOYEE" }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/humanresources/nodes/23/members/add" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "userIds": [42, 108], "role": "MEMBER_EMPLOYEE" }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/humanresources/nodes/23/members/add', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ userIds: [42, 108], role: 'MEMBER_EMPLOYEE' }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/humanresources/nodes/23/members/add', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ userIds: [42, 108], role: 'MEMBER_EMPLOYEE' }),
})

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

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.success boolean Подтверждение того, что участники добавлены

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

JSON 
{
  "success": true,
  "data": {
    "success": true
  }
}

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

400 — не передана роль:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Ошибка при валидации объекта запроса",
    "validation": [
      {
        "field": "MISSING_ROLE",
        "message": "Parameter \"role\" is required."
      }
    ]
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_PARAMS Не передан параметр role (validation[].field = MISSING_ROLE)
400 INVALID_PARAMS Недопустимое значение role для типа узла. Сообщение перечисляет разрешённые роли (validation[].field = INVALID_ROLE)
400 INVALID_PARAMS Нечисловой id в пути — id must be a positive integer
404 NOT_FOUND Неизвестный глагол в пути после members/. Сообщение перечисляет разрешённые: move, remove, add, set
403 SCOPE_DENIED Ключу не хватает скоупа humanresources
401 TOKEN_MISSING У API-ключа не настроены токены Битрикс24

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

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

Список ролей приходит в сообщении об ошибке. При недопустимой для типа узла роли (validation[].field = INVALID_ROLE) сообщение перечисляет разрешённые значения — по этому списку можно подобрать корректную роль без обращения к справочнику.

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