---
schema_version: "1"
id: e81c2617aa104fea40b0e3fb725e29d6236bc9ce6540ba24d9bb3524ee544b2a
title: Cancel Appointment Action
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/health_cloud_object_reference/actions_obj_cancel_appointment.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/actions_obj_cancel_appointment.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 6156d871fd818c737ff7f452b78404a986956c8cc99bd256779cbfe723dc36c9
description: Cancel an existing appointment.
---
# Cancel Appointment Action

Cancel an existing appointment.

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

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d301543e98">Input</th>

              <th class="featureTableHeader  " id="d301543e101">Type</th>

              <th class="featureTableHeader  " id="d301543e104">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d301543e98" data-title="Input">
                <span class="keyword parmname">cancellationReason</span>
              </td>

              <td class="entry" headers="d301543e101" data-title="Type">String</td>

              <td class="entry" headers="d301543e104" data-title="Description">Reason for the cancellation.</td>

            </tr>

            <tr>
              <td class="entry" headers="d301543e98" data-title="Input">
                <span class="keyword parmname">comment</span>
              </td>

              <td class="entry" headers="d301543e101" data-title="Type">String</td>

              <td class="entry" headers="d301543e104" data-title="Description">Additional notes or comments for the cancellation.</td>

            </tr>

            <tr>
              <td class="entry" headers="d301543e98" data-title="Input">
                <span class="keyword parmname">id</span>
              </td>

              <td class="entry" headers="d301543e101" data-title="Type">String</td>

              <td class="entry" headers="d301543e104" data-title="Description">Required<p class="p">Unique identifier of the appointment to update. This is
                  part of the request URL.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d301543e98" data-title="Input">
                <span class="keyword parmname">status</span>
              </td>

              <td class="entry" headers="d301543e101" data-title="Type">String</td>

              <td class="entry" headers="d301543e104" data-title="Description">Required<p class="p">New status for the appointment. Must be a valid
                  cancellation status such as
                  <var class="keyword varname">Cancelled</var>.
                </p>
              </td>

            </tr>

          </tbody>

        </table>

## 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": \[\]
}