Create SLA Policy

Prev Next
Post
/api/v1/livechat/sla
Premium tag

Permission required: manage-livechat-sla

Changelog

Version Description
6.0.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
{
  "name": "Optimum",
  "description": "OPtimum SLA",
  "dueTimeInMinutes": 4
}
object
name
string Required

The name of the SLA policy.

description
string Required

The SLA description.

dueTimeInMinutes
integer Required

The SLA due time.

Responses
200

OK

Success Example
{
  "sla": {
    "name": "Optimum",
    "description": "Optimum SLA",
    "dueTimeInMinutes": 4,
    "_id": "641db89a7718f90c810429cc"
  },
  "success": true
}
Expand All
object
sla
object
name
string
description
string
dueTimeInMinutes
integer
_id
string
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "must have required property 'name' [invalid-params]",
  "errorType": "invalid-params"
}
Example 2
{
  "success": false,
  "error": "must have required property 'dueTimeInMinutes' [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
Tags