Set SLA Policy to Inquiry

Set SLA policy to an inquiry.

  • It requires either the view-l-room or manage-livechat-sla permission.

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

HTTP MethodURLRequires Auth

PUT

/api/v1/livechat/inquiry.setSLA

Body Parameters

KeyExample ValueDescription

roomId*

ZDYMFPpvnXgptmzMs

The room ID.

sla*

6417f67528384134ed600dc6

Name or ID of the SLA policy.

Example Call

curl --location --request PUT 'http://localhost:3000/api/v1/livechat/inquiry.setSLA' \
--header 'x-auth-token: fjiPBhtyFAn5JO3RDdDvKjkXToV2pd4_lb-nkdgJ_Q4' \
--header 'x-user-id: rbAXPnMktTFbNpwtJ' \
--data '{
    "roomId":"ZDYMFPpvnXgptmzMs",
    "sla":"6417f67528384134ed600dc6"
}'

Example Response

Success

{
    "success": true
}

Error

Any of the following errors can occur on the endpoint.

  • Authorization: Requires an authentication token for the request to be made.

  • No Permission: Occurs when the authenticated user neither has the view-l-room nor manage-livechat-sla permission.

  • Invalid Inquiry: This occurs when the inquiry is invalid.

{
    "status": "error",
    "message": "You must be logged in to do this."
}

Change Log

VersionDescription

5.0.0

Added

Last updated

Rocket.Chat versions receive support for six months after release.