---
schema_version: "1"
id: d1d5f09b617b04b09532b26392f72d160817be14459b792ae93e721df74c2472
title: Update 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_update_appointment.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/actions_obj_update_appointment.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 74964ca1dba62d85ecd675df7befedcc863e635f56fa0d7242f67f075b8b4ce2
description: Update an existing appointment.
---
# Update Appointment Action

Update 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**: PUT

**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="d316289e98">Input</th>

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

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

            </tr>

          </thead>

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

              <td class="entry" headers="d316289e101" data-title="Type">Array</td>

              <td class="entry" headers="d316289e104" data-title="Description">Type of appointment, such as
                <span class="keyword parmname">Follow-up</span>.<p class="p">Required, if none of the
                  <span class="keyword parmname">workTypeId</span>,
                  <span class="keyword parmname">serviceTypes</span>, or
                  <span class="keyword parmname">serviceCategories</span> are
                  provided.
                </p>
              </td>

            </tr>

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

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

              <td class="entry" headers="d316289e104" data-title="Description">Engagement channel associated with the appointment.<p class="p">Required, if an engagement channel is configured for a visit type.</p>
              </td>

            </tr>

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

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

              <td class="entry" headers="d316289e104" data-title="Description">Notes associated with the appointment. The maximum
                length is 256 characters.</td>

            </tr>

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

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

              <td class="entry" headers="d316289e104" data-title="Description">Description of the appointment.</td>

            </tr>

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

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

              <td class="entry" headers="d316289e104" data-title="Description">End time of the appointment.</td>

            </tr>

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

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

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

            </tr>

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

              <td class="entry" headers="d316289e101" data-title="Type">Array</td>

              <td class="entry" headers="d316289e104" data-title="Description">List of participants involved in the appointment.<p class="p">For single resource appointment, include either a Device (asset) or a Provider. For multi-resource appointment, include both.</p>
              </td>

            </tr>

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

              <td class="entry" headers="d316289e101" data-title="Type">Array</td>

              <td class="entry" headers="d316289e104" data-title="Description">List of service categories performed during the
                appointment.<p class="p">Required, if none of the
                  <span class="keyword parmname">workTypeId</span>,
                  <span class="keyword parmname">serviceTypes</span>, or
                  <span class="keyword parmname">appointmentType</span> are
                  provided.
                </p>
              </td>

            </tr>

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

              <td class="entry" headers="d316289e101" data-title="Type">Array</td>

              <td class="entry" headers="d316289e104" data-title="Description">A list of specific services to be performed during this
                appointment.<p class="p">Required, if none of the
                  <span class="keyword parmname">workTypeId</span>,
                  <span class="keyword parmname">appointmentType</span>, or
                  <span class="keyword parmname">serviceCategories</span> are
                  provided.
                </p>
              </td>

            </tr>

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

              <td class="entry" headers="d316289e101" data-title="Type">Array</td>

              <td class="entry" headers="d316289e104" data-title="Description">A list of references to the slots that this appointment is filling.<p class="p"><strong class="ph b">Required</strong>: Required, if the appointment is being booked for an external
                  resource.</p>
              </td>

            </tr>

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

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

              <td class="entry" headers="d316289e104" data-title="Description">Required, if
                <span class="keyword parmname">workTypeId</span> is not provided.<p class="p">External system defined in Salesforce, such as
                  <var class="keyword varname">cerner</var>.
                </p>
              </td>

            </tr>

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

              <td class="entry" headers="d316289e101" data-title="Type">Array</td>

              <td class="entry" headers="d316289e104" data-title="Description">A list of the specialties of a practitioner that would be required to perform the service requested in this appointment.</td>

            </tr>

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

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

              <td class="entry" headers="d316289e104" data-title="Description">Start time of the appointment.</td>

            </tr>

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

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

              <td class="entry" headers="d316289e104" data-title="Description">Timezone in which the appointment is booked.</td>

            </tr>

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

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

              <td class="entry" headers="d316289e104" data-title="Description">Visit type associated with the appointment.<p class="p">Required, if none of the
                  <span class="keyword parmname">appointmentType</span>,
                  <span class="keyword parmname">serviceTypes</span>, or
                  <span class="keyword parmname">serviceCategories</span> are
                  provided.
                </p>
              </td>

            </tr>

          </tbody>

        </table>

## Outputs

| Output | Type | Description |
| --- | --- | --- |
| id | String | ID of the appointment. |
| isSuccess | Boolean | Indicates whether the appointment was updated successfully (true) or not (false). |
| status | String | Status of the appointment, such as Scheduled or Rejected. |
| errorMessages | Array | List of errors, if any. |

## Example

**PUT**

This sample request is for the Update Appointment action.

{
  "inputs": \[
    {
      "id": "08pxx000000Axq6xxC",
      "workTypeId": "08qxx000000Axq6xxC",
      "channelId": "0eFSG000000NNOV2A0",
      "description": "Discussion",
      "startDate": "2025-07-21T18:00:00.000Z",
      "endDate": "2025-07-21T18:30:00.000Z",
      "comment": "Payload for the internal salesforce system",
      "participants": \[
        {
          "reference": "Patient/001xx000012udqQxxQ"
        },
        {
          "reference": "Practitioner/0bSxx0000005JoaxxE",
          "isReferenceRequired": true
        },
        {
          "reference": "Facility/001xx000012udqhxxA"
        }
      \]
    }
  \]
}

This sample response is for the Update Appointment action.

\[
  {
    "id": "08pxx000000Axq6xxC",
    "isSuccess": true,
    "status": "Scheduled",
    "errorMessages": \[\]
  }
\]