Leave Room

REST API Leave Methods

Causes the caller to be removed from the room.
URL
Requires Auth
HTTP Method
/api/v1/rooms.leave
yes
POST
Payload
Argument
Example
Required
Description
roomId
ByehQjC44FwMeiLbX
Required
The room's id
Example Call
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-type: application/json" \
     http://localhost:3000/api/v1/rooms.leave \
     -d '{ "roomId": "ByehQjC44FwMeiLbX" }'
Example Result
{
  "success": true
}
Change Log
Version
Description
0.72.0
Added

URL	Requires Auth	HTTP Method
`/api/v1/rooms.leave`	`yes`	`POST`

Argument	Example	Required	Description
`roomId`	`ByehQjC44FwMeiLbX`	Required	The room's id

Version	Description
0.72.0	Added

Last modified 2mo ago