Toggle menu


Set a case SLA. This can be used to add and SLA to a case that doesn't have one, or update an existing SLA.

Note that many of the operations are available in dedicated, simplified End Points.






Required PropertiesTypeDescription
caseBusinessKeyString <businessKey>The business key of the case
durationStringAn ISO8601 duration value (for example P2D for two days). Pass an empty string if setting datetime
Optional PropertiesTypeDescription
datetimeStringAn ISO8601 date and time, eg "2027-03-01T13:00:00Z". Used with the SET operation
operationStringDefault: NOW. One of:

NOW - set the SLA relative to the current time by the duration
CLEAR - clear the SLA
INITIAL - reset the SLA to what it was at the start of the workflow
ADD - extend the SLA by the duration
SUBTRACT - reduce the SLA by the duration
SET - set the SLA as the provided datetime
noteStringA note that will be added to the case history
privateBooleanDefault: false. Set true to log a private note (only visible to case managers)
userNameStringThis user will be recorded as the user adding the note. You must make sure the user exists
userRoleStringThe role of the user logging the note (eg "staff" or "citizen")
displayNameStringThe display name of the user logging the note
debugBooleanDefault: false. Set true to return debug information ("notes") in the response message


See Case Management API for a full example call.

This example sets the SLA to a fixed date.

    "duration": "",
    "caseBusinessKey": "9198-9523-3868-8305",
    "operation": "SET",
    "datetime": "2027-03-01T13:00:00Z"



This response includes debug notes.

    "jsonrpc": "2.0",
    "id": 189,
    "result": {
        "success": true,
        "errors": [],
        "notes": ["Target: 2027-03-01T13:00:00.000Z", "Target update message sent to workflow", "Timer set requested"]


    "jsonrpc": "2.0",
    "id": 190,
    "result": {
        "success": false,
        "errors": ["Cannot set workflow variable form_CASETARGETDATE"],
        "notes": ["Target: 2027-03-01T13:00:00.000Z", "Timer set requested"]

Last modified on 19 February 2024

Share this page

Facebook icon Twitter icon email icon


print icon