Create an SLA policy (desk:admin)
POST /api/desk/v1/sla/policies
Module: Desk · operationId: createSlaPolicy · Tag: SLA · Auth: access token (Authorization: Bearer <accessToken>)
Policies are ordered; the first enabled policy whose match condition holds applies to a new item. Running clocks keep the values they started with (SLA-008); see POST /sla/recalculate.
Request body
application/json (required)
key(string, required): Key of the policy, unique in the tenantname(string, required): Name of the policytargets(array of object, required): Targets of the policyminutes(integer, required): Target in minutestarget(string, required): What is measured (one offirst_response,resolution,next_response)byPriority(object): Minutes per priority keyescalations(array of object): Levels of the target: when a clock reachespercentof it, desk writes the eventdesk.sla.escalatedwith the level – what happens then is an automation's or a flow's (a level has no actions of its own).id(string, required): Key-like idpercent(integer, required): Share of the target at which the level is reached (max 1000)name(string): Name of the level (at most 120 characters), in the event asescalation.name
mode(string): business: service hours of the calendar; wall: wall-clock time (one ofbusiness,wall)warnPercent(integer): Share of the target at which the clock warns (default80)
archived(boolean): Archived: the policy is kept for existing data but no longer offered in pickerscalendar(string): Calendar key; empty = the default calendardescription(string): Description of the policyenabled(boolean): Disabled policies never matchid(string, read-only): Id of the policymatch(string): The tickets the policy applies to: a bool expression in the flow language overtrigger.data, the ticket's event payload (GET /conditions/catalog,item) – the first enabled policy whose match holds applies. Empty: every ticket. One that cannot be evaluated for a ticket does not hold (logged). (max length 4000)position(integer, read-only): Matching order (the first enabled policy that matches applies)reevaluateOn(array of string): Item fields whose change re-matches the policy and recalculates running clocks (e.g. priority)version(integer): Version of the policy; send it back on change (409 version_conflict when it is outdated)note(string): Why the configuration changes (trimmed, at most 500 characters, line breaks allowed; empty = no note) (max length 500)
Example:
{
"calendar": "geschaeftszeiten",
"description": "Kürzere Ziele für Tickets mit dem Label vip",
"enabled": true,
"key": "vip",
"match": "\"vip\" in trigger.data.labels",
"name": "VIP-Kunden",
"note": "Eigene Ziele für die Geschäftsführung unserer Kunden",
"reevaluateOn": [
"priority"
],
"targets": [
{
"minutes": 60,
"mode": "business",
"target": "first_response",
"warnPercent": 75
},
{
"minutes": 480,
"mode": "business",
"target": "resolution",
"warnPercent": 75
}
]
}
Responses
- 201 Created (
application/json)
Fields of the 201 answer:
key(string, required): Key of the policy, unique in the tenantname(string, required): Name of the policytargets(array of object, required): Targets of the policyminutes(integer, required): Target in minutestarget(string, required): What is measured (one offirst_response,resolution,next_response)byPriority(object): Minutes per priority keyescalations(array of object): Levels of the target: when a clock reachespercentof it, desk writes the eventdesk.sla.escalatedwith the level – what happens then is an automation's or a flow's (a level has no actions of its own).id(string, required): Key-like idpercent(integer, required): Share of the target at which the level is reached (max 1000)name(string): Name of the level (at most 120 characters), in the event asescalation.name
mode(string): business: service hours of the calendar; wall: wall-clock time (one ofbusiness,wall)warnPercent(integer): Share of the target at which the clock warns (default80)
archived(boolean): Archived: the policy is kept for existing data but no longer offered in pickerscalendar(string): Calendar key; empty = the default calendardescription(string): Description of the policyenabled(boolean): Disabled policies never matchid(string, read-only): Id of the policymatch(string): The tickets the policy applies to: a bool expression in the flow language overtrigger.data, the ticket's event payload (GET /conditions/catalog,item) – the first enabled policy whose match holds applies. Empty: every ticket. One that cannot be evaluated for a ticket does not hold (logged). (max length 4000)position(integer, read-only): Matching order (the first enabled policy that matches applies)reevaluateOn(array of string): Item fields whose change re-matches the policy and recalculates running clocks (e.g. priority)version(integer): Version of the policy; send it back on change (409 version_conflict when it is outdated)
Example 201 answer:
{
"archived": false,
"calendar": "geschaeftszeiten",
"description": "Erste Reaktion in 4 Stunden, Lösung je nach Priorität (Geschäftszeiten)",
"enabled": true,
"id": "9d6e7f8a-0b1c-4d2e-9f4a-6b7c8d9e0f01",
"key": "standard",
"match": "trigger.data.spaceKey == \"SUP\"",
"name": "Standard",
"position": 0,
"reevaluateOn": [
"priority"
],
"targets": [
{
"escalations": [
{
"id": "reaktion-ueberfaellig",
"name": "Die erste Reaktion ist überfällig",
"percent": 100
}
],
"minutes": 240,
"mode": "business",
"target": "first_response",
"warnPercent": 80
},
{
"byPriority": {
"hoch": 480,
"kritisch": 240,
"niedrig": 2880,
"normal": 1440
},
"escalations": [
{
"id": "loesung-ueberfaellig",
"name": "Die Lösung ist überfällig",
"percent": 100
}
],
"minutes": 1440,
"mode": "business",
"target": "resolution",
"warnPercent": 80
}
],
"version": 2
}
Example request
curl -X POST 'https://api.mbcom.cloud/api/desk/v1/sla/policies' \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
--data '{"calendar":"geschaeftszeiten","description":"Kürzere Ziele für Tickets mit dem Label vip","enabled":true,"key":"vip","match":"\"vip\" in trigger.data.labels","name":"VIP-Kunden","note":"Eigene Ziele für die Geschäftsführung unserer Kunden","reevaluateOn":["priority"],"targets":[{"minutes":60,"mode":"business","target":"first_response","warnPercent":75},{"minutes":480,"mode":"business","target":"resolution","warnPercent":75}]}'