Cancel Appointment Action

This action is available in API version 65.0 and later.

Supported REST HTTP Methods

URI: /services/data/vXX.X/connect/health/appointment-management/appointment/{id}

Where XX.X is the latest API version.

Formats: JSON, XML

HTTP Methods: PATCH

Authentication: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

Inputs

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

Outputs

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

Usage

PATCH

This sample request is for the Cancel Appointment action.

{
    "id": "08xxG000000Axx6YAC",
    "status": "Cancelled",
    "cancellationReason": "Patient requested cancellation.",
    "comment": "Patient will call back to reschedule."
}

This sample response is for the Cancel Appointment action.

{
    "id": "08pxx000000Axx6YAC",
    "isSuccess": true,
    "status": "Cancelled",
    "errorMessages": []
}