---
schema_version: "1"
id: a371061f184b35deea8f0783acdb15ca47b0ce9de8d6b00da7f418f6e354be87
title: Update Appointment (PUT)
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/health_cloud_object_reference/connect_resources_appointment_management_update_appointment.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resources_appointment_management_update_appointment.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: d3f95fd1d18e307ed341d62cd3fc99b6acdacf9e6b67903083173454d21a3872
description: Update an appointment.
---
# Update Appointment (PUT)

Update an appointment.

## Resource

/connect/health/appointment-management/appointment/{appointmentId}

## Resource Example

Replace {yourInstance} with the My Domain name of your Salesforce org.

https://{yourInstance}.salesforce.com/services/data/v68.0/connect/health/appointment-management/​appointment/​08pxx0000004KxxAAE

## HTTP Methods

PUT

## Request Body for PUT (LS)

{
  "workTypeId": "08qxx0000004C97AAE",
  "id": "08pxx0000004KGG", -- id of the appointment to
  "channelId": "0eFxx0000000001EAA",
  "startDate": "2025-09-20T00:15:00Z",
  "endDate": "2025-09-20T00:45:00Z",
  "timeZone": "America/Indiana/Indianapolis",
  "comment": "Payload for the internal salesforce system to book a provider.",
  "participants": \[
    {
      "reference": "Patient/001xx000003GYimAAG"
    },
    {  
        "reference": "Practitioner/0bSxx000000000AEAQ",
        "isReferenceRequired": true
    },
    {
        "reference": "Facility/001xx000003GYj3AAG"
    }
  \]
}

## Request Body for PUT (External EHR System)

{
  "startDate": "2026-12-10T09:00:00Z",
  "endDate": "2026-12-10T11:00:00Z",
  "workTypeId": "08qxx0000004C97AAE",
  "channelId": "0eFxx0000000001EAA",
  "id": "08pxx0000004KGG", -- id of the appointment to
  "sourceSystem": "cerner",
  "comment": "Update the current appointment with new date",
  "appointmentTypes": \[
	"FOLLOWUP"
  \],
  "serviceCategories": \[
    "serviceCategoryCode1",
    "serviceCategoryCode2"
  \],
  "serviceTypes": \[
    "serviceTypeCode1",
    "serviceTypeCode2"
  \],
  "specialties": \[
    "specialityCode"
  \],
  "slots": \[
    {
      "id": "24477854-21304876-62852027-2",
      "reference": "<healthcarePractitionerId>" - matches with the reference of practitioner within participants
    }
  \],
  "participants": \[
    {
      "reference": "Patient/<patientId>"
    },
    {
      "reference": "Facility/<facilityId>"
    },
    {
      "reference": "Practitioner/<healthcarePractitionerId>",
      "isReferenceRequired": true
    }
  \]
}  

## Request Parameters for PUT

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





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d611915e112">Parameter Name</th>

              <th class="featureTableHeader vertical-align-top " id="d611915e115">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d611915e118">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d611915e121">Required or Optional</th>

              <th class="featureTableHeader  " id="d611915e124">Available version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d611915e112" data-title="Parameter Name"><samp class="codeph nolang">appointmentTypes</samp></td>

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

              <td class="entry" headers="d611915e118" data-title="Description">Type of appointment, such as <samp class="codeph nolang">Follow up</samp>.</td>

              <td class="entry" headers="d611915e121" data-title="Required or Optional">Required, if none of the following are provided:<a name="ul_cvy_qnw_kgc"><!-- --></a>
                <ul class="ul bulletList" id="ul_cvy_qnw_kgc">
                  <li class="li"><samp class="codeph nolang">workTypeId</samp></li>

                  <li class="li"><samp class="codeph nolang">serviceTypes</samp></li>

                  <li class="li"><samp class="codeph nolang">serviceCategories</samp></li>

                </ul>
              </td>

              <td class="entry" headers="d611915e124" data-title="Available version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d611915e112" data-title="Parameter Name"><samp class="codeph nolang">channelId</samp></td>

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

              <td class="entry" headers="d611915e118" data-title="Description">Engagement channel associated with the appointment, such as <samp class="codeph nolang">In person</samp> or <samp class="codeph nolang">video</samp>.</td>

              <td class="entry" headers="d611915e121" data-title="Required or Optional">Required if an engagement channel is configured for a visit type.</td>

              <td class="entry" headers="d611915e124" data-title="Available version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d611915e112" data-title="Parameter Name"><samp class="codeph nolang">comment​</samp></td>

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

              <td class="entry" headers="d611915e118" data-title="Description">Additional text to aid in facilitating the
                appointment.</td>

              <td class="entry" headers="d611915e121" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d611915e124" data-title="Available version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d611915e112" data-title="Parameter Name"><samp class="codeph nolang">endDate</samp></td>

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

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

              <td class="entry" headers="d611915e121" data-title="Required or Optional">Required</td>

              <td class="entry" headers="d611915e124" data-title="Available version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d611915e112" data-title="Parameter Name"><samp class="codeph nolang">id</samp></td>

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

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

              <td class="entry" headers="d611915e121" data-title="Required or Optional">Required</td>

              <td class="entry" headers="d611915e124" data-title="Available version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d611915e112" data-title="Parameter Name"><samp class="codeph nolang">participants</samp></td>

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

              <td class="entry" headers="d611915e118" data-title="Description">List of participants involved in the appointment.
                Patient and Facility are required. For single resource
                appointment, include either a <samp class="codeph nolang">Device</samp> (asset) or
                <samp class="codeph nolang">Provider</samp> or
                both for multi-resource appointment.
              </td>

              <td class="entry" headers="d611915e121" data-title="Required or Optional">Required</td>

              <td class="entry" headers="d611915e124" data-title="Available version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d611915e112" data-title="Parameter Name"><samp class="codeph nolang">serviceCategories</samp></td>

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

              <td class="entry" headers="d611915e118" data-title="Description">List of categories of service to include.</td>

              <td class="entry" headers="d611915e121" data-title="Required or Optional">Required, if none of the following are provided:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">workTypeId</samp></li>

                  <li class="li"><samp class="codeph nolang">serviceTypes</samp></li>

                  <li class="li"><samp class="codeph nolang">appointmentType</samp></li>

                </ul>
              </td>

              <td class="entry" headers="d611915e124" data-title="Available version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d611915e112" data-title="Parameter Name"><samp class="codeph nolang">serviceTypes</samp></td>

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

              <td class="entry" headers="d611915e118" data-title="Description">List of specific services to include.</td>

              <td class="entry" headers="d611915e121" data-title="Required or Optional">Required, if none of the following are provided:<a name="ul_zh3_snw_kgc"><!-- --></a>
                <ul class="ul bulletList" id="ul_zh3_snw_kgc">
                  <li class="li"><samp class="codeph nolang">workTypeId</samp></li>

                  <li class="li"><samp class="codeph nolang">serviceCategories</samp></li>

                  <li class="li"><samp class="codeph nolang">appointmentType</samp></li>

                </ul>
              </td>

              <td class="entry" headers="d611915e124" data-title="Available version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d611915e112" data-title="Parameter Name"><samp class="codeph nolang">slots</samp></td>

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

              <td class="entry" headers="d611915e118" data-title="Description">List of references to the slots the appointment is
                filling. </td>

              <td class="entry" headers="d611915e121" data-title="Required or Optional">Required, if the appointment is for an external
                resource.</td>

              <td class="entry" headers="d611915e124" data-title="Available version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d611915e112" data-title="Parameter Name"><samp class="codeph nolang">sourceSystem</samp></td>

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

              <td class="entry" headers="d611915e118" data-title="Description">External system defined in Salesforce, such as
                <var class="keyword varname">cerner</var> .
              </td>

              <td class="entry" headers="d611915e121" data-title="Required or Optional">Required, if <samp class="codeph nolang">workTypeId</samp> is not provided but one of <samp class="codeph nolang">appointmentType</samp>, <samp class="codeph nolang">serviceTypes</samp>, or <samp class="codeph nolang">serviceCategories</samp> is.</td>

              <td class="entry" headers="d611915e124" data-title="Available version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d611915e112" data-title="Parameter Name"><samp class="codeph nolang">specialties</samp></td>

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

              <td class="entry" headers="d611915e118" data-title="Description">List of the specialties of a practitioner required for the service.</td>

              <td class="entry" headers="d611915e121" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d611915e124" data-title="Available version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d611915e112" data-title="Parameter Name"><samp class="codeph nolang">startDate</samp></td>

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

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

              <td class="entry" headers="d611915e121" data-title="Required or Optional">Required</td>

              <td class="entry" headers="d611915e124" data-title="Available version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d611915e112" data-title="Parameter Name"><samp class="codeph nolang">timeZone</samp></td>

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

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

              <td class="entry" headers="d611915e121" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d611915e124" data-title="Available version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d611915e112" data-title="Parameter Name"><samp class="codeph nolang">workTypeId</samp></td>

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

              <td class="entry" headers="d611915e118" data-title="Description">Visit type associated with the appointment.</td>

              <td class="entry" headers="d611915e121" data-title="Required or Optional">Required, if none of the following are provided:<a name="ul_mqc_pnw_kgc"><!-- --></a>
                <ul class="ul bulletList" id="ul_mqc_pnw_kgc">
                  <li class="li"><samp class="codeph nolang">appointmentType</samp></li>

                  <li class="li"><samp class="codeph nolang">serviceTypes</samp></li>

                  <li class="li"><samp class="codeph nolang">serviceCategories</samp></li>

                </ul>
              </td>

              <td class="entry" headers="d611915e124" data-title="Available version">65.0</td>

            </tr>

          </tbody>

        </table>

## Response Body for PUT

[Update Appointment Output](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_appointment_management.htm "Output representation for appointment management.")