Creates an appointment on a case.
Namespace
goss.CaseManagement.v1.api.case.caseAppointments.caseAppointmentCreate
Worker
serverlibrary
Parameters
| Required Properties | Type | Description |
|---|---|---|
| caseBusinessKey | String <businessKey> | The business key of the case |
| caseAppointmentToSave | Object | Details of the appointment |
| caseAppointmentToSave.appointmentDate | String <date-time> | The date and time of the appointment |
| caseAppointmentToSave.minutes | Number | The length of the appointment in minutes |
| caseAppointmentToSave.departmentName | String | The name of the department |
| caseAppointmentToSave.departmentGroupName | String | The name of the department group |
| caseAppointmentToSave.with | String | Who the appointment is with |
| caseAppointmentToSave.location | String | Where the appointment takes place |
| user | Object | Details of the user |
| user.siteUserName | String | The username of a valid case manager |
| Optional Properties | Type | Description |
| caseAppointmentToSave.notes | String | Notes about the appointment |
{
"caseBusinessKey": "0123-4567-8901-2345",
"caseAppointmentToSave": {
"appointmentDate": "2026-01-01T09:00:00.000Z",
"minutes": 45,
"departmentName": "Abc",
"departmentGroupName": "Abc",
"with": "Abc",
"location": "Abc",
"notes": "Abc"
},
"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 |
| Case must be active | User aUser does not have permissions to add an appointment |
| 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 add an appointment |
Behaviour
If the validation rules pass
- Adds the appointment to the case
Last modified on 23 October 2026
