---
schema_version: "1"
id: 9b6e51917bcd5f2f8bb6893d149a474a9d8830523beeb0b410206eb51f6a5952
title: "Flow Action: Cancel Appointment"
collection: admin
version: current
locale: en-us
portal_url: https://docs.salesforce.com/admin/current/en-us/platform/264-0-0/ls_flowactions_cancel_appointment.md
canonical_url: https://help.salesforce.com/s/articleView?id=platform.ls_flowactions_cancel_appointment.htm&release=264.0.0&type=5
source_site: help.salesforce.com
content_type: documentation
content_hash: 0bccf1f4f2f92a763811bce5c546f695c1a4d76a59fcebcede69d97cfd4fb799
description: Use the Cancel Appointment action to cancel appointments and to capture cancellation reasons.
products:
  - Scheduler
  - Salesforce Platform
release: "264"
---
# Flow Action: Cancel Appointment

Use the Cancel Appointment action to cancel appointments and to capture cancellation reasons.

### Required Editions

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small edition"><colgroup><col></colgroup><tbody><tr class=""><td class="slds-cell-wrap" style="vertical-align:top;">Available in: Lightning Experience.</td></tr><tr class=""><td class="slds-cell-wrap" style="vertical-align:top;">Available in: <strong>Enterprise</strong> and <strong>Unlimited</strong> Editions</td></tr></tbody></table>

![Note](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-platform-scheduler-264-0-0-production-enus/0530be2f-891f-4263-a0d7-96ddca56a717/images/icon_note.png)

Note Users who run this action must have access to the service appointment record that they cancel. If you can't update a user's access, contact Salesforce Customer Support.

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
        <colgroup>
          <col style="width:33.33333333333333%">
          <col style="width:33.33333333333333%">
          <col style="width:33.33333333333333%">
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d16250e71">Input Value</th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d16250e74">Description</th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d16250e77">Data Type</th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="Input Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d16250e71 ">Service Appointment Status</td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d16250e74 ">
              <p>The status of the service appointment. </p>
              <p style="margin-bottom:0;">Example: Canceled</p>
            </td>

            <td data-label="Data Type" class="slds-cell-wrap" style="vertical-align:top;" headers="d16250e77 ">String</td>

          </tr>
          <tr class="">
            <td data-label="Input Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d16250e71 ">Service Appointment ID</td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d16250e74 ">
              <p>The ID of the service appointment.</p>
              <p style="margin-bottom:0;">Example: 08pxx0000004GNwAAM</p>
            </td>

            <td data-label="Data Type" class="slds-cell-wrap" style="vertical-align:top;" headers="d16250e77 ">String</td>

          </tr>
          <tr class="">
            <td data-label="Input Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d16250e71 ">Cancellation Reason</td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d16250e74 ">The reason for canceling the appointment.</td>

            <td data-label="Data Type" class="slds-cell-wrap" style="vertical-align:top;" headers="d16250e77 ">String</td>

          </tr>
          <tr class="">
            <td data-label="Input Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d16250e71 ">Create Service Appointment URL</td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d16250e74 ">The URL to include in the cancellation confirmation email. This URL launches
              the create guest appointment flow.</td>

            <td data-label="Data Type" class="slds-cell-wrap" style="vertical-align:top;" headers="d16250e77 ">String</td>

          </tr>
          <tr class="">
            <td data-label="Input Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d16250e71 ">Confirmation Email Template Name</td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d16250e74 ">The developer name of the template for the cancellation confirmation email that
              you send to the customer that cancels the appointment.</td>

            <td data-label="Data Type" class="slds-cell-wrap" style="vertical-align:top;" headers="d16250e77 ">String</td>

          </tr>
          <tr class="">
            <td data-label="Input Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d16250e71 ">Email Template for Authenticated Payment Refunds</td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d16250e74 ">
              <p style="margin-bottom:0;" dir="ltr">The developer name of the template that sends authenticated users an
                email after a paid appointment is canceled. </p>
            </td>

            <td data-label="Data Type" class="slds-cell-wrap" style="vertical-align:top;" headers="d16250e77 ">String</td>

          </tr>
          <tr class="">
            <td data-label="Input Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d16250e71 ">Email Template for Guest Payment Refunds</td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d16250e74 ">
              <p style="margin-bottom:0;" dir="ltr">The developer name of the template that sends guest users an email
                after a paid appointment is canceled.</p>
            </td>

            <td data-label="Data Type" class="slds-cell-wrap" style="vertical-align:top;" headers="d16250e77 ">String</td>

          </tr>
        </tbody>
      </table>

  
| Output Value | Description | Data Type |
| --- | --- | --- |
| Error Message | Any error message that’s generated when saving the appointment. | String |