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

Удалить участника

DELETE /v1/chats/:chatId/users

Удаляет одного пользователя из группового чата.

Параметры

Параметр Тип Обяз. Описание
chatId (path) number да Числовой ID чата (без префикса chat)
format (query) string нет v2 включает режим v2 — см. «Режим v2» ниже. Любое другое значение игнорируется, ответ прежний. Повтор format не отклоняется: из format=v1&format=v2 берётся последнее значение, то есть режим v2, а format=v2&format=v1 даёт прежний ответ. Форма format[]=v2 включает режим v2, если все её значения — v2

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

Поле Тип Обяз. Описание
userId number да ID пользователя для удаления — положительное целое: число или строка из десятичных цифр без ведущих нулей и пробелов, не больше 2^53−1; любая другая форма отклоняется до обращения к порталу

Режим v2. format=v2 удаляет участника через мессенджер v2 с тем же телом { "userId": … }. Написание Битрикс24 USER_ID, другие поля тела и query-параметры отклоняются с 400 INVALID_PARAMS. В data приходит { "result": true } вместо true. Пользователь не из чата — 422 BITRIX_ERROR с error.b24Code USER_NOT_FOUND.

Примеры

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/chats/123/users" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "userId": 42 }'

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/chats/123/users" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "userId": 42 }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/123/users', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ userId: 42 }),
})

const { success, data } = await res.json()
console.log('Удалён:', data)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/123/users', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ userId: 42 }),
})

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

curl — режим v2

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/chats/123/users?format=v2" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "userId": 42 }'

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data boolean true при успешном удалении
data.result boolean Режим v2: true — участник удалён

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

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

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

422 — пользователь не состоит в чате:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Указанный пользователь не состоит в чате"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_CHAT_ID chatId не является положительным целым числом — проверяется до обращения в Битрикс24
400 MISSING_PARAMS Поле userId отсутствует (в том числе запрос вовсе без тела)
400 INVALID_PARAMS userId не является положительным целым в каноничной записи — массив, слово, ноль, отрицательное, дробное, с ведущими нулями или пробелами, больше 2^53−1. В режиме v2 также query-параметр кроме format, поле тела кроме userId, тело не JSON-объект. В Битрикс24 ничего не отправлено
403 WRITE_BLOCKED_READONLY_KEY Ключ только для чтения — см. права доступа
403 SCOPE_DENIED API-ключ не имеет скоупа im
401 TOKEN_MISSING API-ключ не имеет настроенных токенов Битрикс24
422 BITRIX_ERROR Битрикс24 вернул ошибку — текст в поле message (например, пользователь не состоит в чате или нет прав). В режиме v2 код портала приходит в error.b24Code
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ошибку сервера

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

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

Удаление по одному. Эндпоинт принимает один userId (число), не массив. Чтобы удалить нескольких участников, вызывайте метод для каждого отдельно.

Только числовой ID. Битрикс24 приводит userId к числу по правилам PHP: массив [47] превращается в 1 — из чата был бы удалён пользователь с ID 1, обычно владелец портала, а не 47. Поэтому форма значения проверяется на стороне API: принимаются число и строка из десятичных цифр без ведущих нулей и пробелов, остальное — 400 INVALID_PARAMS.

В Битрикс24 уходят только chatId и userId. Другие поля тела запроса не передаются на портал — в том числе нативные ключи Битрикс24 в верхнем регистре. Портал сворачивает имена параметров без учёта регистра, и последний ключ побеждает: тело {"USER_ID": 47, "user_id": [1]} прошло бы проверку по USER_ID, а на портале победил бы алиас — из чата был бы удалён пользователь с ID 1.

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