Set SLA Policy to Inquiry

Prev Next
Put
/api/v1/livechat/inquiry.setSLA
Premium tag

Set SLA policy to an inquiry. You can only set the policy for an inquiry that has not been taken by an agent.

At least one of the following permissions is required:

  • view-l-room
  • manage-livechat-sla

Changelog

Version Description
5.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
{
  "roomId": "ZDYMFPpvnXgptmzMs",
  "sla": "6417f67528384134ed600dc6"
}
object
roomId
string Required

The room ID.

sla
string Required

Name or ID of the SLA policy.

Responses
200

OK

Success
{
  "success": true
}
object
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "The 'roomId' param is required"
}
Example 2
{
  "success": false,
  "error": "error-invalid-inquiry"
}
object
success
boolean
error
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