Close Livechat Room
- Print
- DarkLight
- PDF
Close Livechat Room
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/api/v1/livechat/room.closeByUser
If you are an Omnichannel user (agent, manager), use this endpoint to close the livechat room.
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
Example 1
{
"rid": "8ceKgWvo5qT5TrCRN",
"comment": "close via API",
"tags": [
"abc",
"abc"
],
"transcriptEmail": {
"sendToVisitor": true,
"requestData": {
"email": "[email protected]",
"subject": "transcript"
}
}
}object
rid
string Required
Enter the livechat room ID.
Example8ceKgWvo5qT5TrCRN
comment
string
Add a description for closing the room.
string
generateTranscriptPdf
boolean
Enter whether you want to generate a conversation transcript PDF.
transcriptEmail
object
sendToVisitor
boolean
Enter whether you want to send the livechat transcript to the visitor.
requestData
object
email
string
Enter the visitor's email ID to whom you want to send the transcript.
subject
string
Enter a subject for the email.
Responses
200
OK
Success
{
"success": true
}object
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "must have required property 'rid' [invalid-params]",
"errorType": "invalid-params"
}Example 2
{
"success": false,
"error": "error-room-already-closed"
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
Was this article helpful?