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

Установить право удалять участников

PUT /v1/chats/:dialogId/permissions/users-delete

Задаёт, кто в чате может удалять участников: все участники, менеджеры с владельцем или только владелец.

Параметры

Параметр Тип Обяз. Описание
dialogId (path) string да ID диалога: chatXXX для группового чата, числовой ID пользователя для личных сообщений, me — личный диалог текущего пользователя. Чат сущности CRM находится через Найти чат CRM-сущности

Query-параметров у операции нет: любой параметр в строке запроса отклоняется с 400 INVALID_PARAMS.

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

Поле Тип Обяз. Описание
rightsLevel string да Кому выдано право: MEMBER — всем участникам, MANAGER — менеджерам и владельцу, OWNER — только владельцу. Регистр не учитывается: manager и MANAGER равнозначны

Другие поля тела отклоняются с 400 INVALID_PARAMS, сообщение называет лишнее поле.

Сразу после создания группового чата право имеет значение MANAGER.

Примеры

Примеры разрешают удалять участников только владельцу.

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

Terminal 
curl -X PUT https://vibecode.bitrix24.tech/v1/chats/chat2741/permissions/users-delete \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rightsLevel": "OWNER"}'

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

Terminal 
curl -X PUT https://vibecode.bitrix24.tech/v1/chats/chat2741/permissions/users-delete \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"rightsLevel": "OWNER"}'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat2741/permissions/users-delete', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ rightsLevel: 'OWNER' }),
})

const { success } = await res.json()

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/chat2741/permissions/users-delete', {
  method: 'PUT',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ rightsLevel: 'OWNER' }),
})

const { success } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data boolean true — право сохранено

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

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

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

400 — в запросе rightsLevel равно "NONE", такого значения нет в наборе операции:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Body field `rightsLevel` must be one of MANAGER, MEMBER, OWNER (any case)."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS rightsLevel нет в теле или значения нет в наборе операции: MEMBER, MANAGER, OWNER. Сообщение перечисляет допустимые значения
400 INVALID_PARAMS В теле есть поле, кроме rightsLevel
400 INVALID_PARAMS Тело запроса не JSON-объект
400 INVALID_PARAMS В строке запроса есть параметр
403 BITRIX_ACCESS_DENIED Битрикс24 отказал: пользователь не участник чата или право settings не разрешает ему менять права
422 BITRIX_ERROR Битрикс24 вернул ошибку, код портала — в error.b24Code. Чата нет — CHAT_NOT_FOUND
403 SCOPE_DENIED API-ключ не имеет скоупа im
403 WRITE_BLOCKED_READONLY_KEY Ключ в режиме «только чтение» — изменение прав считается записью
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24
502 ME_ALIAS_RESOLUTION_FAILED dialogId=me — не удалось определить ID текущего пользователя
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ошибку сервера

Все отказы 400 приходят до обращения к Битрикс24.

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

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

Где посмотреть текущее значение. Поле permissions.manageUsersDelete ответа Информация о диалоге возвращает право в нижнем регистре, например owner.

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