Cancel Appointment (PATCH)

Cancel a health appointment.

Resource 

1/connect/health/appointment-management/​appointment/​{appointmentId}

Resource Example 

Replace {yourInstance} with the My Domain name of your Salesforce org.

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/health/appointment-management/​appointment/​08pxx0000004KxxAAE

HTTP Methods 

PATCH

Request Body for PATCH 

1{
2  "id": "08pxx0000004KhxxAE",
3  "status": "canceled"
4}

Request Parameters for PATCH 

Parameter NameTypeDescriptionRequired or OptionalAvailable version
idStringID of the appointment to cancel.Required65.0
statusStringStatus to set the appointment to, ​as configured in Salesforce appointment statuses.Required65.0

Response Body for PATCH 

Cancel Appointment Output