#Переместить участников

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

Перемещает указанных сотрудников в целевой узел и назначает им роль внутри него. Принимает список идентификаторов сотрудников и одну роль, общую для всего списка.

#Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор целевого узла — куда перемещаются участники

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

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

#Примеры

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

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

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

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

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

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

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

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/humanresources/nodes/23/members/move',
  {
    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_HEAD' }),
  }
)
const body = await res.json()

#Поля ответа

Поле Тип Описание
success boolean true при успешном выполнении
data.success boolean true, если участники перемещены

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

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 Не передана роль либо :id не является положительным целым числом
404 NOT_FOUND Неизвестная операция в пути после members
403 SCOPE_DENIED Ключу не хватает скоупа humanresources
401 TOKEN_MISSING У API-ключа не настроены токены Битрикс24

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

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

  • Одна роль на весь список. Все сотрудники из userIds получают одну и ту же роль. Чтобы назначить разные роли, вызовите операцию отдельно для каждой роли либо задайте весь состав узла через Заменить состав.

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