Close Livechat Room

HTTP MethodURLRequires Auth

POST

/api/v1/livechat/room.close

no

Body

KeyExample ValueDescription

rid*

XFzMqgn33DcsQkpJp

The room _id.

token*

iNKE8a6k6cjbqWhWd

The visitor token.

Example Call

curl -X POST \
     -H "Content-type:application/json" \
     http://localhost:3000/api/v1/livechat/room.close \
     -d '{"rid": "XFzMqgn33DcsQkpJp", 
          "token": "iNKE8a6k6cjbqWhWd"}'

Example Response

{
  "rid": "XFzMqgn33DcsQkpJp",
  "comment": "Closed by visitor",
  "success": true
}

Last updated

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