Update Appointment (PUT)

Update an appointment.

Resource

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

Resource Example

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

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

HTTP Methods

PUT

Request Body for PUT (LS)

1{
2  "workTypeId": "08qxx0000004C97AAE",
3  "id": "08pxx0000004KGG", -- id of the appointment to
4  "channelId": "0eFxx0000000001EAA",
5  "startDate": "2025-09-20T00:15:00Z",
6  "endDate": "2025-09-20T00:45:00Z",
7  "timeZone": "America/Indiana/Indianapolis",
8  "comment": "Payload for the internal salesforce system to book a provider.",
9  "participants": [
10    {
11      "reference": "Patient/001xx000003GYimAAG"
12    },
13    {  
14        "reference": "Practitioner/0bSxx000000000AEAQ",
15        "isReferenceRequired": true
16    },
17    {
18        "reference": "Facility/001xx000003GYj3AAG"
19    }
20  ]
21}

Request Body for PUT (External EHR System)

1{
2  "startDate": "2026-12-10T09:00:00Z",
3  "endDate": "2026-12-10T11:00:00Z",
4  "workTypeId": "08qxx0000004C97AAE",
5  "channelId": "0eFxx0000000001EAA",
6  "id": "08pxx0000004KGG", -- id of the appointment to
7  "sourceSystem": "cerner",
8  "comment": "Update the current appointment with new date",
9  "appointmentTypes": [
10	"FOLLOWUP"
11  ],
12  "serviceCategories": [
13    "serviceCategoryCode1",
14    "serviceCategoryCode2"
15  ],
16  "serviceTypes": [
17    "serviceTypeCode1",
18    "serviceTypeCode2"
19  ],
20  "specialties": [
21    "specialityCode"
22  ],
23  "slots": [
24    {
25      "id": "24477854-21304876-62852027-2",
26      "reference": "<healthcarePractitionerId>" - matches with the reference of practitioner within participants
27    }
28  ],
29  "participants": [
30    {
31      "reference": "Patient/<patientId>"
32    },
33    {
34      "reference": "Facility/<facilityId>"
35    },
36    {
37      "reference": "Practitioner/<healthcarePractitionerId>",
38      "isReferenceRequired": true
39    }
40  ]
41}

Request Parameters for PUT

Parameter Name	Type	Description	Required or Optional	Available version
`appointmentTypes`	Array	Type of appointment, such as `Follow up`.	Required, if none of the following are provided: `workTypeId` `serviceTypes` `serviceCategories`	65.0
`channelId`	String	Engagement channel associated with the appointment, such as `In person` or `video`.	Required if an engagement channel is configured for a visit type.	65.0
`comment`	String	Additional text to aid in facilitating the appointment.	Optional	65.0
`endDate`	String	End time of the appointment.	Required	65.0
`id`	String	ID of the appointment.	Required	65.0
`participants`	Array	List of participants involved in the appointment. Patient and Facility are required. For single resource appointment, include either a `Device` (asset) or `Provider` or both for multi-resource appointment.	Required	65.0
`serviceCategories`	Array	List of categories of service to include.	Required, if none of the following are provided: `workTypeId` `serviceTypes` `appointmentType`	65.0
`serviceTypes`	Array	List of specific services to include.	Required, if none of the following are provided: `workTypeId` `serviceCategories` `appointmentType`	65.0
`slots`	Array	List of references to the slots the appointment is filling.	Required, if the appointment is for an external resource.	65.0
`sourceSystem`	String	External system defined in Salesforce, such as cerner .	Required, if `workTypeId` is not provided but one of `appointmentType`, `serviceTypes`, or `serviceCategories` is.	65.0
`specialties`	Array	List of the specialties of a practitioner required for the service.	Optional	65.0
`startDate`	String	Start time of the appointment.	Required	65.0
`timeZone`	String	Timezone in which the appointment is updated.	Optional	65.0
`workTypeId`	String	Visit type associated with the appointment.	Required, if none of the following are provided: `appointmentType` `serviceTypes` `serviceCategories`	65.0

Response Body for PUT

Update Appointment Output