Post
/api/v1/teams.removeRoom
Removes a room from a team.
Permissions required: remove-team-channel
, view-all-team-channels
Header parameters
X-User-Id
stringRequired
The userId
of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
X-Auth-Token
stringRequired
The authToken
of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
Body parameters
Example
{
"teamId": "63f3efc4b000b6b6d86704b2",
"roomId": "JKa7R9zu2DinBhBN9"
}
object
teamName
string
Enter the team name. This parameter is required if teamId
is not provided.
Exampleteam01
teamId
string
Enter the team ID. This parameter is required if teamName
is not provided.
Exampled8eiFT9fIwfs
roomId
string
The room ID to be removed from the team.
Example8dugqGhuRvCBLdZft
Responses
200
OK
Success
{
"room": {
"_id": "JKa7R9zu2DinBhBN9",
"fname": "Livestream",
"customFields": {},
"description": "",
"broadcast": false,
"encrypted": false,
"federated": false,
"name": "Livestream",
"t": "c",
"msgs": 15,
"usersCount": 3,
"u": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "roxie"
},
"ts": "2023-02-22T17:15:26.989Z",
"ro": false,
"default": false,
"sysMes": true,
"_updatedAt": "2023-09-29T05:51:47.779Z",
"lm": "2023-09-14T12:06:00.594Z",
"lastMessage": {
"_id": "rtf5JoPLQup3X7Aof",
"t": "videoconf",
"msg": "",
"groupable": false,
"blocks": [
{
"type": "video_conf",
"blockId": "6502f728a2f73c7460df6f71",
"callId": "6502f728a2f73c7460df6f71",
"appId": "videoconf-core"
}
],
"ts": "2023-09-14T12:06:00.594Z",
"u": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "test.test",
"name": "test test"
},
"rid": "JKa7R9zu2DinBhBN9",
"_updatedAt": "2023-09-14T12:06:00.685Z",
"urls": [],
"mentions": [],
"channels": []
}
},
"success": true
}
object
room
object
_id
string
fname
string
customFields
object
description
string
broadcast
boolean
encrypted
boolean
federated
boolean
name
string
t
string
msgs
integer
usersCount
integer
u
object
_id
string
username
string
ts
string
ro
boolean
default
boolean
sysMes
boolean
_updatedAt
string
lm
string
lastMessage
object
_id
string
t
string
msg
string
groupable
boolean
blocks
Array of object
object
type
string
blockId
string
callId
string
appId
string
ts
string
u
object
_id
string
username
string
name
string
rid
string
_updatedAt
string
urls
Array of object
object
mentions
Array of object
object
channels
Array of object
object
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}
object
status
string
message
string