06.04.2026 22:55

RemoveParticipants

[POST] .../v1/chat/removeparticipants

Удаляет участников из чата.

Входные параметры

Название Тип данных Обязательность Описание
id String Обязательный UUID чата
participants Array of ChatParticipantRemove Обязательный Список участников для удаления
ChatParticipantRemove
Название Тип данных Описание
entity_type Enum Тип участника: User, Client, ChatBot
entity_id Int64 ID сущности участника

Ограничения и проверки

  • id должен быть корректным UUID существующего чата.
  • participants обязателен и должен содержать хотя бы одного участника.
  • Для каждого элемента participants обязательны корректные entity_type и entity_id (entity_id > 0).
  • Допустимые типы для удаления: User, Client, ChatBot.
  • В participants не должно быть дубликатов одной и той же пары (entity_type + entity_id).
  • Метод доступен только участнику чата с ролью Staff.
  • Для пользователей с правом chat_manage_all (688) метод также доступен в обычных чатах.
  • Для entity-чатов (Task/Lead/Deal/Ticket) прямое изменение состава участников через этот метод запрещено.
  • Для entity-чатов обратная синхронизация из Chat/* в сущность не выполняется; состав берется только из связанной сущности.
  • Нельзя удалить всех участников чата: после операции в чате должен остаться минимум один участник.
  • Если переданные участники не найдены в чате, метод завершится без изменений (row_affected = 0).

Пример запроса

{
  "id": "6f6fdb2f-7d0b-4c34-b6fd-1fbcf40d37ef",
  "participants": [
    {
      "entity_type": "User",
      "entity_id": 21
    }
  ]
}

Выходные параметры

Название Тип данных Описание
result.row_affected Int64 Количество измененных строк

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

{
  "ok": true,
  "result": {
    "row_affected": 1,
    "ids": null
  }
}