Обновление канала команды
Метод и конечная точка
PUT /teams/{teamId}/channels/{roomId}
Описание
Обновляет настройки канала в команде, например, флаг автоматического добавления (auto join).
Параметры
Перечень параметров представлен в таблице.
| Название | Обязательный | Тип данных | Описание |
|---|---|---|---|
| teamId | да | string | Идентификатор команды (в пути) |
| roomId | да | string | Идентификатор канала (в пути) |
| isDefault | нет | boolean | Флаг автоматического добавления (auto join) |
Запрос
curl -X 'PUT' \
'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/teams/<TEAM_ID>/channels/<ROOM_ID>' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-User-Id: <USER_ID>' \
-H 'x-auth-token: <AUTH_TOKEN>' \
-d '{ \
"isDefault": true
}'
Где:
<ENV>— окружение, на котором выполняется запрос;<DEFAULT_DOMAIN>— домен сервера Squadus;<USER_ID>— идентификатор пользователя, от имени которого выполняется запрос;<AUTH_TOKEN>— токен аутентификации пользователя;<TEAM_ID>— идентификатор команды;<ROOM_ID>— идентификатор канала.
Ответ
200 — Teams — Канал обновлен. Пример вывода:
{
"success": true,
"room": {
"_id": "general",
"name": "general",
"teamDefault": true
}
}