Выход из команды

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

PUT /teams/{teamId}/leave

Описание

Позволяет пользователю выйти из команды. Можно также указать каналы команды, из которых пользователь будет исключен.

Параметры

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

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

Запрос

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

Где:

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

Ответ

200 — Info about user and his rooms — Информация о пользователе и его комнатах. Пример вывода:

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