Cancels a task. The task can be cancelled even if not set as "cancellable" in its configuration.
The user details supplied when cancelling the task should be those of the assigned case manager, or the system user. The system user is defined in the Setup and Naming section of the case configuration and by convention is called CMSYSTEMUSER.
Namespace
goss.CaseManagement.v1.api.caseTask.caseTaskCancel
Worker
serverlibrary
Parameters
| Name | Type | Description |
|---|---|---|
| caseBusinessKey | String | Required. The business key of the parent case |
| caseTaskToCancel | Object | Required |
| caseTaskToCancel.businessKey | String <business-key> | Required. The business key of the task to cancel |
| caseTaskToCancel.notes | String | Optional notes added to the case history |
| user | Object | Required. Details of the user cancelling the task. This must be the current case manager, or the system user if the case is unclaimed |
| user.displayName | String | Optional. A name to use in the case history notes |
| user.siteUserName | String | Required. The username as set in iCM |
| proxyUser | Object | Optional. Details of the user being proxied (eg this could be the system user, while the user is the actual user) |
| proxyUser.displayName | String | Optional. A name to use in the case history notes |
| proxyUser.siteUserName | String | Required. The username as set in iCM |
Example
See Case Management API for the full example call structure.
{
"caseBusinessKey": "9770-3153-1627-4765",
"caseTaskToCancel": {
"notes": "Abc",
"businessKey": "3104-5017-2730-1176"
},
"user": {
"displayName": "Abc",
"siteUserName": "Abc"
},
"proxyUser": {
"displayName": "Abc",
"siteUserName": "Abc"
}
}
Responses
Success
Details of the cancelled task.
{
"id": 120,
"result": {
"success": true,
"complete": true,
"startTime": "2026-03-26T09:25:57.391Z",
"endTime": "2026-03-26T09:25:58.011Z",
"duration": 620,
"updatedTasks": [{
"summary": "Email Conversation",
"groupName": "groupName",
"raised": "2026-03-26T08:20:53.399Z",
"taskType": "emailconversation71",
"businessKey": "3104-5017-2730-1176",
"processName": "cmemailconversationv1",
"taskName": "Email Conversation",
"taskID": 3,
"id": "3104-5017-2730-1176",
"showReadOnly": false,
"groupID": "CM-ALLOTMENTENQUIRIES",
"formEnquiry": "CASEMANAGEMENTEMAILCONVERSATIONENQUIRYVIEWV1EN",
"details": "Email Conversation",
"updated": "2026-03-26T09:25:58.008Z",
"created": "2026-03-26T08:20:53.399Z",
"showAttachments": "",
"permissions": {
"canCancel": false,
"canView": true,
"canReassign": true
},
"userName": "not my username",
"attachments": {
"allAttachments": false,
"showAttachments": ""
},
"allAttachments": false,
"status": "Cancelled",
"lastUpdated": "2026-03-26T08:34:21.906Z",
"userID": "timg",
"taskStatus": {
"code": "New",
"description": "New",
"statusDescs": {
"escalated": "Escalated",
"error": "Error",
"start": "New",
"cancelled": "Cancelled",
"inProgress": ["Open"],
"end": "Closed"
},
"statusList": {
"escalated": "Escalated",
"error": "Error",
"start": "New",
"cancelled": "Cancelled",
"inProgress": ["Open"],
"end": "Closed"
}
},
"started": "2026-03-26T08:20:53.399Z",
"cancellable": false,
"statusDesc": "Cancelled",
"ended": "2026-03-26T09:25:58.008Z"
}]
},
"jsonrpc": "2.0"
}
