Skip to main content

Удаление каналов из команды

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

DELETE /teams/{teamId}/channels

Описание​

Удаляет каналы из команды. Требует права remove-team-channel.

Параметры​

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

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

Запрос​

curl -X 'DELETE' \
'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/teams/<TEAM_ID>/channels' \
-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 — Removed rooms — Удаленные каналы. Пример вывода:

{
"success": true,
"data": {
"rooms": [
{
"_id": "general",
"name": "general"
}
]
}
}