Post
/api/v1/livechat/room.saveInfo
Edit a Livechat room. Update the topic, tags, and other details of a Livechat room.
Permission required: view-l-room
Changelog
| Version | Description |
|---|---|
| 5.3.0 | Added |
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
{
"guestData": {
"_id": "rbAXPnMktTFbNpwtJ"
},
"roomData": {
"_id": "nf52k8bpJ8y7oHmwk",
"topic": "Hmm",
"tags": [
"testtags"
]
}
}object
guestData
object
_id
string Required
The guest ID.
name
string
The name of the guest.
email
string
The email of the guest.
phone
string
The contact of the guest.
livechatData
object
Custom fields information.
roomData
object
_id
string Required
The room ID.
topic
string
The topic of the room.
tags
Array of string
An array of tags to be associated with the room.
string
priorityId
string
The priority ID of the room.
slaId
string
The SLA priority ID of the room.
livechatData
object
Custom fields information.
Responses
200
OK
Success
{
"success": true
}object
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "must have required property 'guestData' [invalid-params]",
"errorType": "invalid-params"
}Example 2
{
"success": false,
"error": "must have required property 'roomData' [invalid-params]",
"errorType": "invalid-params"
}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
403
Forbidden
Permission Error
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}Unauthorized
{
"success": false,
"error": "unauthorized"
}object
success
boolean
error
string