Escalates a case to the escalated status.
Namespace
goss.CaseManagement.v1.api.case.caseEscalate
Worker
serverlibrary
Parameters
| Required Properties | Type | Description |
|---|---|---|
| caseBusinessKey | String | The business key of the case |
| caseEscalated | Object | Details of the escalation |
| caseEscalated.escalationReason | String | The reason for the escalation |
| caseEscalated.escalationNotes | String | Notes about the escalation |
| user | Object | Details of the user |
| user.siteUserName | String | The username of a valid case manager |
| Optional Properties | Type | Description |
| n/a | n/a | n/a |
{
"caseBusinessKey": "0123-4567-8901-2345",
"caseEscalated": {
"escalationReason": "Abc",
"escalationNotes": "Abc"
},
"user": {
"siteUserName": "Abc"
}
}
Returns
| Property | Type | Description |
|---|---|---|
| success | Boolean | Whether the request completed successfully |
| errors | Array | Any errors that occurred. Only returned if there are errors |
| warnings | Array | Any warnings that occurred. Only returned if there are warnings |
Rules
| Rule | Validation error |
|---|---|
| User must exist | Could not retrieve siteUser details |
| Case must exist | Could not retrieve case Case 1234-5678-9012-3456 |
| Case must be active | User aUser does not have permissions to escalate the case |
| User must be a member of the case managers group or the case manager if one is assigned | User aUser does not have permissions to escalate the case |
Behaviour
If the validation rules pass
- Updates the case to the escalated status
- The escalation reason and notes are recorded against the case
Last modified on 20 October 2026
