Login
    Contents x
    Close Livechat Room
      • Print
      • Dark
        Light
      • PDF
      Contents

      Close Livechat Room

        • Print
        • Dark
          Light
        • PDF
        Article summary

        Post
        /api/v1/livechat/room.close
        Body parameters
        Example 1
        {
  "rid": "XFzMqgn33DcsQkpJp",
  "token": "iNKE8a6k6cjbqWhWd"
}
        object
        rid
        string Required

        The room ID.

        ExampleXFzMqgn33DcsQkpJp
        token
        string Required

        The visitor token.

        ExampleiNKE8a6k6cjbqWhWd
        Responses
        200
        Success Example
        {
  "rid": "XFzMqgn33DcsQkpJp",
  "comment": "Closed by visitor",
  "success": true
}
        object
        rid
        string
        comment
        string
        success
        boolean
        400

        Bad Request

        Example 1
        {
  "success": false,
  "error": "must have required property 'token' [invalid-params]",
  "errorType": "invalid-params"
}
        Example 2
        {
  "success": false,
  "error": "must have required property 'rid' [invalid-params]",
  "errorType": "invalid-params"
}
        object
        success
        boolean
        error
        string
        errorType
        string
        Was this article helpful?
        What's Next
        Rocket.Chat versions receive support for six months after release.
        Change password!
        Changing your password will log you out immediately. Use the new password to log back in.
        Change profile
        Success!
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.
        Logout