leave-room.md

Leave Room

Causes the request sender to be removed from the room.

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

Body Parameters

Key	Example Value	Description
roomId*	ByehQjC44FwMeiLbX	The room 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 Response

{
  "success": true
}

Change Log

Version	Description
0.72.0	Added