Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Book Slot Chain (POST)

Create service appointments for a care program enrollee in advanced therapy management based on the provided appointment slots.

This API takes both the published and unpublished slots as inputs. If the provided slots are published, the API calls the Salesforce Scheduler API to book the slots.

Resource

1/connect/health/advanced-therapy-management/book-slot-chain

Resource example

1https://yourInstance.salesforce.com/services/data/v67.0/connect/health/advanced-therapy-management/book-slot-chain

Available version

60.0

HTTP methods

POST

Request body for POST

JSON example

1{
2   "careProgramEnrolleeId":"08pxx0000004C92AAE",
3   "workProcedureId":"08pxx0000004C92AAE",
4   "slots":[
5      {
6         "schedStartTime":"2022-03-26T16:30:00.000+0000",
7         "schedEndTime":"2022-03-26T16:30:00.000+0000",
8         "workTypeId":"08pxx0000004C92AAE",
9         "serviceTerritoryId":"08pxx0000004C92AAE",
10         "serviceResourceId":"08pxx0000004C92AAE",
11         "contactId":"08pxx0000004C92AAE",
12         "appointmentType":"08pxx0000004C92AAE",
13         "subject":"Apheresis",
14         "additionalInformation":"Needs Cab Assistance",
15         "street":"1 Market Street",
16         "city":"San Francisco",
17         "state":"CA",
18         "postalCode":"94105",
19         "country":"USA",
20         "comments":"",
21         "status":"Scheduled"
22      },
23      {
24         "schedStartTime":"2022-03-26T16:30:00.000+0000",
25         "schedEndTime":"2022-03-26T16:30:00.000+0000",
26         "workTypeId":"08pxx0000004C92AAE",
27         "serviceTerritoryId":"08pxx0000004C92AAE",
28         "serviceResourceId":"08pxx0000004C92AAE",
29         "contactId":"08pxx0000004C92AAE",
30         "appointmentType":"08pxx0000004C92AAE",
31         "subject":"Apheresis",
32         "additionalInformation":"Needs Cab Assistance",
33         "street":"1 Market Street",
34         "city":"San Francisco",
35         "state":"CA",
36         "postalCode":"94105",
37         "country":"USA",
38         "comments":"",
39         "status":"Scheduled"
40      },
41      {
42         "schedStartTime":"2022-03-26T16:30:00.000+0000",
43         "schedEndTime":"2022-03-26T16:30:00.000+0000",
44         "workTypeId":"08pxx0000004C92AAE",
45         "serviceTerritoryId":"08pxx0000004C92AAE",
46         "serviceResourceId":"08pxx0000004C92AAE",
47         "contactId":"08pxx0000004C92AAE",
48         "appointmentType":"08pxx0000004C92AAE",
49         "subject":"Apheresis",
50         "additionalInformation":"Needs Cab Assistance",
51         "street":"1 Market Street",
52         "city":"San Francisco",
53         "state":"CA",
54         "postalCode":"94105",
55         "country":"USA",
56         "comments":"",
57         "status":"Scheduled"
58      }
59   ]
60}

Properties

Name	Type	Description	Required or Optional	Available Version
`careProgramEnrolleeId`	String	ID of the care program enrollee for whom the service appointments must be created.	Required	60.0
`slots`	Slots []	Appointment slots to be booked.	Required	60.0
`workProcedureId`	String	ID of the work procedure for which the service appointments are to be created.	Required	60.0

Response body for POST

Book Slot Chain Output

Agentforce Health Developer Guide

Book Slot Chain (POST)