Join Livechat Room

Call this endpoint to join a Livechat room.

This requires the view-l-room permission.

HTTP MethodURLRequires Auth



Query Parameters

KeyExample ValueDescription



Room ID that you want to join.

Example Call

curl --location --request GET 'http://localhost:3000/api/v1/livechat/room.join?roomId=gMMeBpWyLeowCrzBv' \
--header 'Content-type: application/json' \
--header 'X-Auth-Token: OsLBoPh6cUgNuh6mWT8z4VIY_nGl8R30XVE4QNDLT6S' \
--header 'X-User-Id: f5vPj6jfkRXipkwoC' \
--data-raw ''

Example Response


    "success": true


Any of the following errors can occur on the endpoint.

  • Authorization: Requires an authentication token for the request to be made.

  • Missing key: This error is thrown when the roomId field is not supplied.

  • Invalid Room: Occurs when the given roomId is invalid.

  • Not allowed: Occurs when the authenticated user doesn't have permission to access the room.

    "status": "error",
    "message": "You must be logged in to do this."

Last updated

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