Leave Room

Prev Next
Post
/api/v1/rooms.leave

Leave a room. The following permissions are required:

  • leave-c: To leave a public room.
  • leave-p: To leave private room.

Changelog

Version Description
0.72.0 Added
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Body parameters
object
roomId
string

The room ID that you want to leave.

ExampleByehQjC44FwMeiLbX
Responses
200

OK

Success
{
  "success": true
}
object
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string