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

Input	Type	Description
`appointmentTypes`	Array	Type of appointment, such as `Follow-up`. Required, if none of the `workTypeId`, `serviceTypes`, or `serviceCategories` are provided.
`channelId`	String	Engagement channel associated with the appointment. Required, if an engagement channel is configured for a visit type.
`comment`	String	Notes associated with the appointment. The maximum length is 256 characters.
`description`	String	Description of the appointment.
`endDate`	String	End time of the appointment.
`id`	String	Required The unique identifier of the appointment to update. This is part of the request URL.
`participants`	Array	List of participants involved in the appointment. For single resource appointment, include either a Device (asset) or a Provider. For multi-resource appointment, include both.
`serviceCategories`	Array	List of service categories performed during the appointment. Required, if none of the `workTypeId`, `serviceTypes`, or `appointmentType` are provided.
`serviceTypes`	Array	A list of specific services to be performed during this appointment. Required, if none of the `workTypeId`, `appointmentType`, or `serviceCategories` are provided.
`slots`	Array	A list of references to the slots that this appointment is filling. Required: Required, if the appointment is being booked for an external resource.
`sourceSystem`	String	Required, if `workTypeId` is not provided. External system defined in Salesforce, such as cerner.
`specialties`	Array	A list of the specialties of a practitioner that would be required to perform the service requested in this appointment.
`startDate`	String	Start time of the appointment.
`timeZone`	String	Timezone in which the appointment is booked.
`workTypeId`	String	Visit type associated with the appointment. Required, if none of the `appointmentType`, `serviceTypes`, or `serviceCategories` are provided.

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.

1{
2  "inputs": [
3    {
4      "id": "08pxx000000Axq6xxC",
5      "workTypeId": "08qxx000000Axq6xxC",
6      "channelId": "0eFSG000000NNOV2A0",
7      "description": "Discussion",
8      "startDate": "2025-07-21T18:00:00.000Z",
9      "endDate": "2025-07-21T18:30:00.000Z",
10      "comment": "Payload for the internal salesforce system",
11      "participants": [
12        {
13          "reference": "Patient/001xx000012udqQxxQ"
14        },
15        {
16          "reference": "Practitioner/0bSxx0000005JoaxxE",
17          "isReferenceRequired": true
18        },
19        {
20          "reference": "Facility/001xx000012udqhxxA"
21        }
22      ]
23    }
24  ]
25}

This sample response is for the Update Appointment action.

1[
2  {
3    "id": "08pxx000000Axq6xxC",
4    "isSuccess": true,
5    "status": "Scheduled",
6    "errorMessages": []
7  }
8]