Для AI-агентов: markdown этой страницы — /docs-content/workgroups/members/role.md индекс документации — /llms.txt

Изменить роль участников

PATCH /v1/workgroups/:groupId/users

Назначает участникам рабочей группы роль модератора или возвращает им роль участника. Одна роль применяется сразу ко всем пользователям из userIds.

Параметры

Параметр	Тип	Обяз.	Описание
`groupId` (path)	number	да	Идентификатор рабочей группы — положительное целое число. Список: `GET /v1/workgroups`

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

Поле	Тип	Обяз.	Описание
`userIds`	number[]	да	Непустой массив идентификаторов участников группы — положительных целых чисел. Состав группы: `GET /v1/workgroups/:groupId/users`
`role`	string	да	Новая роль: `moderator` — модератор, `member` — участник. В составе группы они видны как `E` и `K`

Примеры

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

Terminal

curl -X PATCH "https://vibecode.bitrix24.tech/v1/workgroups/157/users" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"userIds": [93], "role": "moderator"}'

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

Terminal

curl -X PATCH "https://vibecode.bitrix24.tech/v1/workgroups/157/users" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"userIds": [93], "role": "moderator"}'

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/workgroups/157/users', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ userIds: [93], role: 'moderator' }),
})

const body = await res.json()
if (!body.success && body.error.code === 'BITRIX_ERROR') {
  if (Array.isArray(body.error.processedUserIds)) {
    // Часть ролей могла смениться — изменения не откатываются
    console.log('Роль изменена:', body.error.processedUserIds)
    console.log('Роль не изменена:', body.error.skippedUserIds)
  } else {
    // Второй вариант 422: Битрикс24 отказал в вызове, массивов в ответе нет
    console.log('Битрикс24 отказал:', body.error.message)
  }
}

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

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/workgroups/157/users', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ userIds: [93], role: 'moderator' }),
})

const body = await res.json()

Поля ответа

Поле	Тип	Описание
`success`	boolean	`true`, когда роль изменена у всех запрошенных пользователей
`data.groupId`	number	Идентификатор рабочей группы
`data.processedUserIds`	number[]	Идентификаторы пользователей, получивших новую роль. Повторы из `userIds` схлопываются в один
`data.skippedUserIds`	number[]	В успешном ответе всегда пустой массив. Если роль изменилась не у всех, приходит `422 BITRIX_ERROR`, а оба массива переезжают в `error`. Это единственный ответ с массивами: у второго `422 BITRIX_ERROR` — когда Битрикс24 отказал в вызове — в `error` только его собственный текст, без `processedUserIds` и `skippedUserIds`

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

JSON

{
  "success": true,
  "data": {
    "groupId": 157,
    "processedUserIds": [93],
    "skippedUserIds": []
  }
}

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

422 — запрошена роль member: у пользователя 93 она сменилась, у владельца группы 1 — нет: