Post
/api/v1/livechat/monitors.create
Add a user as monitor. Permission required: manage-livechat-monitors
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
{
"username": "cat.kat"
}object
username
string Required
Enter the username that you want to add as monitor.
Exampletest.user
Responses
200
OK
Example 1
{
"_id": "J6Q87AnWP5aNc9xhx",
"username": "cat.kat",
"roles": [
"user",
"livechat-agent"
],
"success": true
}object
_id
string
username
string
roles
Array of string
string
success
boolean
400
Bad Request
Example 1
{
"success": false,
"errorType": "invalid-params",
"error": "must have required property 'username'"
}object
success
boolean
errorType
string
error
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string