Delete a Monitor

Prev Next
Post
/api/v1/livechat/monitors.delete
Premium tag

Delete an Omnichannel 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": "test.user"
}
object
username
string Required

Enter the username that you want to remove as the monitor.

Exampletest.user
Responses
200

OK

Success
{
  "success": true
}
object
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
Tags