Skip to main content

How to cancel an Appointment

To cancel an appointment, you can simply use the same endpoint that is used to update an appointment. The only parameter that needs to be passed is 'status' with the value "CANCELLED". Please check the example below.

For errors and warnings that this endpoint can return, see Update / Cancel appointment — Errors and warnings.

Path parameter:

Parameter NameValueDescriptionRequired
dealerDepartmentUUIDStringUnique identifier of dealer departmentYes
appointmentUuidStringUnique identifier of the appointmentYes

Authorization

This request requires the following authorization scopes:

ScopeLevelDescription
appointment.createDealerDepartmentAuthorises client to create appointment for the provided dealer

Curl to cancel an appointment

curl --location -g --request PATCH 'https://api.mykaarma.com/appointment/v2/department/{{dealerDepartmentUuid}}/appointment/{{appointmentUuid}}' \
--header 'Authorization: {{basic_auth_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"appointmentInformation": {
"status":"CANCELLED"
}
}'