Deletes an appointment from a case.
Namespace
goss.CaseManagement.v1.api.case.caseAppointments.caseAppointmentDelete
Worker
serverlibrary
Parameters
| Required Properties | Type | Description |
|---|---|---|
| caseBusinessKey | String <businessKey> | The business key of the case |
| caseAppointmentToDelete | Object | Details of the appointment |
| caseAppointmentToDelete.id | Number | The index number of the appointment to delete |
| user | Object | Details of the user |
| user.siteUserName | String | The username a valid case manager |
| Optional Properties | Type | Description |
| n/a | n/a | n/a |
{
"caseBusinessKey": "0123-4567-8901-2345",
"caseAppointmentToDelete": {
"id": 1
},
"user": {
"siteUserName": "Abc"
}
}
Returns
| Property | Type | Description |
|---|---|---|
| success | Boolean | Whether the request completed successfully |
| data | Array | Data returned by the request |
| 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 |
| The appointment must exist on the case | The appointment {0} does not exist on case {1} |
| 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 delete an appointment |
Behaviour
If the validation rules pass
- Removes the appointment from the case
Last modified on 23 October 2026
