Create SLA Policy

HTTP MethodURLRequires Auth

POST

api/v1/livechat/sla

Permission required: manage-livechat-sla

Body Parameters

KeyExampleDescription

name*

grand

The name of the SLA policy.

description*

sla description

The SLA description.

dueTimeInMinutes*

4

The SLA due time.

Example Call

curl --location 'http://localhost:3000/api/v1/livechat/sla' \
--header 'X-Auth-Token: q2zjkgQt_OmYaBY4nEp50-r7yUAqVIoAqgo0jjBIws5' \
--header 'X-User-Id: rYhzFRd2QZjNwAAXX' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Optimum",
    "description": "OPtimum SLA",
    "dueTimeInMinutes": 4
}'

Example Response

Success

{
    "sla": {
        "name": "Optimum",
        "description": "Optimum SLA",
        "dueTimeInMinutes": 4,
        "_id": "641db89a7718f90c810429cc"
    },
    "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: This occurs when the authenticated user doesn't have manage-livechat-sla permission.

  • Invalid Parameter: Occurs when a required parameter is not passed.

  • Duplicate: When an SLA is created having the same name or dueTimeInMinutes as an existing SLA.

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

Change Log

VersionDescription

6.0.0

Added

Last updated

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