ConnectCloud Developers

Set the matching order (desk:admin)

POST /api/desk/v1/sla/policies/reorder

Module: Desk · operationId: reorderSlaPolicies · Tag: SLA · Auth: access token (Authorization: Bearer <accessToken>)

Request body

application/json (required)

  • ids (array of string, required)

Example:

{
  "ids": [
    "9d6e7f8a-0b1c-4d2e-9f4a-6b7c8d9e0f02",
    "9d6e7f8a-0b1c-4d2e-9f4a-6b7c8d9e0f01"
  ]
}

Responses

  • 200 Policies in the new order (application/json)

Fields of the 200 answer:

  • items (array of SLAPolicy, required)
    • key (string, required): Key of the policy, unique in the tenant
    • name (string, required): Name of the policy
    • targets (array of object, required): Targets of the policy
      • minutes (integer, required): Target in minutes
      • target (string, required): What is measured (one of first_response, resolution, next_response)
      • byPriority (object): Minutes per priority key
      • escalations (array of object): Levels of the target: when a clock reaches percent of it, desk writes the event desk.sla.escalated with 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 id
        • percent (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 as escalation.name
      • mode (string): business: service hours of the calendar; wall: wall-clock time (one of business, wall)
      • warnPercent (integer): Share of the target at which the clock warns (default 80)
    • archived (boolean): Archived: the policy is kept for existing data but no longer offered in pickers
    • calendar (string): Calendar key; empty = the default calendar
    • description (string): Description of the policy
    • enabled (boolean): Disabled policies never match
    • id (string, read-only): Id of the policy
    • match (string): The tickets the policy applies to: a bool expression in the flow language over trigger.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 200 answer:

{
  "items": [
    {
      "enabled": true,
      "id": "9d6e7f8a-0b1c-4d2e-9f4a-6b7c8d9e0f02",
      "key": "vip",
      "match": "\"vip\" in trigger.data.labels",
      "name": "VIP-Kunden",
      "position": 0,
      "targets": [
        {
          "minutes": 60,
          "mode": "business",
          "target": "first_response"
        }
      ],
      "version": 1
    },
    {
      "enabled": true,
      "id": "9d6e7f8a-0b1c-4d2e-9f4a-6b7c8d9e0f01",
      "key": "standard",
      "match": "trigger.data.spaceKey == \"SUP\"",
      "name": "Standard",
      "position": 1,
      "targets": [
        {
          "minutes": 240,
          "mode": "business",
          "target": "first_response"
        }
      ],
      "version": 3
    }
  ]
}

Example request

curl -X POST 'https://api.mbcom.cloud/api/desk/v1/sla/policies/reorder' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"ids":["9d6e7f8a-0b1c-4d2e-9f4a-6b7c8d9e0f02","9d6e7f8a-0b1c-4d2e-9f4a-6b7c8d9e0f01"]}'

View as Markdown · Interactive reference · OpenAPI