Join a room of any type, including public channels, private groups, and discussions. Unlike the channels.join endpoint, which only joins public channels, this endpoint applies to all kinds of rooms.
Changelog
| Version | Description |
|---|---|
| 8.6.0 | Added |
The authToken of the authenticated user.
The userId of the authenticated user.
{
"roomId": "ByehQjC44FwMeiLbX",
"joinCode": "1234"
}{
"roomName": "general"
}The ID of the room to join. Provide either roomId or roomName.
The join code of the room. Rooms can be password-protected. In that case, users must enter the password for access. The join code isn't needed if the user has the join-without-join-code permission.
The name of the room to join. Provide either roomId or roomName.
The join code of the room. Rooms can be password-protected. In that case, users must enter the password for access. The join code isn't needed if the user has the join-without-join-code permission.
OK
{
"room": {
"_id": "ByehQjC44FwMeiLbX",
"name": "general",
"fname": "general",
"t": "c",
"msgs": 8,
"usersCount": 2,
"u": {
"_id": "rocketchat.internal.admin.test",
"username": "rocketchat.internal.admin.test"
},
"ts": "2026-01-16T12:00:04.783Z",
"ro": false,
"sysMes": true,
"default": true,
"_updatedAt": "2026-01-16T12:06:30.426Z"
},
"success": true
}Bad Request
{
"success": false,
"error": "Match error: Missing key 'roomId'",
"errorType": "error-invalid-params"
}{
"success": false,
"error": "The required \"roomId\" or \"roomName\" param provided does not match any channel [error-room-not-found]",
"errorType": "error-room-not-found"
}Unauthorized
{
"status": "error",
"message": "You must be logged in to do this."
}