Remove a Room from Team

HTTP MethodURLRequires Auth

POST

/api/v1/teams.removeRoom

Permission required: remove-team-channel

Body Parameters

KeyExample ValueDescription

teamId* or teamName*

ByehQjC44FwMeiLbX or team1

The team ID or the team name. You must enter either one of these parameters.

roomId

8Z7eRsibvD5AANfmK

The room ID to be removed from the team.

Example Call

curl  -H 'X-Auth-Token: _2u_4MzRroRcnqc59GYUY_Kwgr9HgtZ9HCKn-2aIvMJ' \
      -H 'X-User-Id: FL2fZL4ERhwA3gWiS' \
      -H "Content-type: application/json" \
      http://localhost:3000/api/v1/teams.removeRoom \
      -d '{ 
            "teamName": "team1", 
            "roomId": "8Z7eRsibvD5AANfmK" }'

Example Response

{
  "room": {
    "_id": "8Z7eRsibvD5AANfmK",
    "name": "roomRemovedFromTheTeam",
    "fname": "roomRemovedFromTheTeam",
    "t": "c",
    "msgs": 7,
    "usersCount": 1,
    "u": {
      "_id": "FL2fZL4ERhwA3gWiS",
      "username": "some.username"
    },
    "customFields": {},
    "description": "",
    "broadcast": false,
    "encrypted": false,
    "ts": "2021-04-27T19:59:07.258Z",
    "ro": false,
    "_updatedAt": "2021-04-28T20:57:18.362Z"
  },
  "success": true
}

Last updated

Rocket.Chat versions receive support for six months after release.