Skip to main content

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

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

DELETE /teams/{teamId}

Описание​

Удаляет команду и связанные с ней каналы. Требует прав на управление командой.

Параметры​

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

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

Запрос​

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

Где:

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

Ответ​

200 — Teams — Команда удалена. Пример вывода:

{
"success": true,
"data": {
"teamId": "team_123456",
"rooms": [
{
"success": ["room_1"],
"errors": []
}
]
}
}