Удаление участников из команды

Метод и конечная точка

DELETE /teams/{teamId}/members

Описание

Удаляет участников из команды. Можно также удалить участников из указанных каналов команды.

Параметры

Перечень параметров представлен в таблице.

Название	Обязательный	Тип данных	Описание
teamId	да	string	Идентификатор команды (в пути)
membersIds	да	array	Список ID пользователей для удаления
roomIds	нет	array	Список каналов команды для удаления участников

Запрос

curl -X 'DELETE' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/teams/<TEAM_ID>/members' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'X-User-Id: <USER_ID>' \
  -H 'x-auth-token: <AUTH_TOKEN>' \
  -d '{ \
  "membersIds": [
  "<MEMBER_ID_1>",
  "<MEMBER_ID_2>"
  ],
  "roomIds": [
  "<ROOM_ID_1>",
  "<ROOM_ID_2>"
  ]
  }'

Где:

• <ENV> — окружение, на котором выполняется запрос;
• <DEFAULT_DOMAIN> — домен сервера Squadus;
• <USER_ID> — идентификатор пользователя, от имени которого выполняется запрос;
• <AUTH_TOKEN> — токен аутентификации пользователя;
• <TEAM_ID> — идентификатор команды;
• <MEMBER_ID_1>, <MEMBER_ID_2> — идентификаторы удаляемых пользователей;
• <ROOM_ID_1>, <ROOM_ID_2> — идентификаторы каналов.

Ответ

200 — Info about removed users and their rooms — Информация об удаленных пользователях. Пример вывода:

{
  "success": true,
  "data": [
    {
      "userId": "user_123",
      "rooms": [
        {
          "success": ["room_1"],
          "errors": []
        }
      ]
    }
  ]
}