How to update an Appointment
You can update appointments in myKaarma for customer visits so that your Service Advisors are aware of the changed schedule and your customers could be notified/reminded for their scheduled visit.
Path parameter:
| Parameter Name | Value | Description | Required |
|---|---|---|---|
dealerDepartmentUUID | String | Unique identifier of dealer department | Yes |
appointmentUuid | String | Unique identifier of the appointment | Yes |
Authorization
This request requires the following authorization scopes:
| Scope | Level | Description |
|---|---|---|
appointment.create | DealerDepartment | Authorises client to create appointment for the provided dealer |
To update an appointment, you have to first the get unique identifier (UUID) of the appointment. This is a patch endpoint, so only detail that has to be updated needs to be sent in the request.
Following details can be updated
- Customer (send the updated customerUuid)
- Vehicle (send the updated vehicleUuid in vehicleInformation)
- Appointment time (send the updated appointmentStartDateTime and appointmentEndDateTime).
- User to which appointment is assigned (send the updated uuid in assignedUser object).
- Transport option (send the updated transportOptionUuid in transportOption object, alternatively you can also send name of the updated transport option in altTransportation in transportOption object)
- Comments related to appointment (comments field), Internal notes related to appointment (internalNotes field), Mileage of the vehicle (mileageText field) are simple string fields.
- Service related to the appointment (serviceList object in the body). Please note that any service that was initially present in the appointment but is not present in update request will be cancelled. So if you plan to add/change a particular service, please fetch the appointment, edit the serviceList accordingly and then send the complete serviceList in the update appointment request.
- Metadata with appointment (appointmentData field in appointmentMetaData object).
On how fetch customer, vehicle or any other parameter, please refer to the create appointment page
Request body
Update appointment and create appointment have same request body. You can view the request body on create appointment page.
Note
This is a patch endpoint, send only the parameters that you want to update.
When updating services, please send the complete list you want in the appointment. Services present in create appointment request but not in update appointment will be marked as invalid.