Cancel Appointment Action | Salesforce Health Cloud Developer Guide

This action is available in API version 65.0 and later.

Supported REST HTTP Methods

URI
/services/data/66.0/connect/health/appointment-management/appointment/{id}
Formats: JSON, XML
HTTP Methods: PATCH
Authentication: Authorization: Bearer Token

Inputs

Input	Details
cancellationReason	Type String Description Reason for the cancellation.
comment	Type String Description Additional notes or comments for the cancellation.
id	Type String Description Required Unique identifier of the appointment to update. This is part of the request URL.
status	Type String Description Required New status for the appointment. Must be a valid cancellation status such as `Cancelled`.

Outputs

Output	Details
errorMessages	Type Array Description A list of errors, if any occurred.
id	Type String Description The id of the Appointment.
isSuccess	Type Boolean Description Indicates whether the appointment was cancelled successfully or not.
status	Type String Description The status of the Appointment, like Scheduled, Rejected.

Usage

PATCH

This sample request is for the Cancel Appointment action.

1{
2    "id": "08xxG000000Axx6YAC",
3    "status": "Cancelled",
4    "cancellationReason": "Patient requested cancellation.",
5    "comment": "Patient will call back to reschedule."
6}

This sample response is for the Cancel Appointment action.

1{
2    "id": "08pxx000000Axx6YAC",
3    "isSuccess": true,
4    "status": "Cancelled",
5    "errorMessages": []
6}