Update Service Appointments

Show the details of service appointments—appointments booked through Salesforce Scheduler—on a page of your app so that business managers or administrators can review and update appointments.

To modify appointments, the branch manager or administrator who’s reassigning service appointments need these user permissions.

Read, Create, and Edit on service appointments
Read on accounts, contacts, operating hours, service resources, service territories, work types, and work type groups

Create a page to review the appointment details and update the service appointment.

To modify a service appointment, link the Next button to a PATCH request on the service-appointments Connect API.

Resource URI

1https://YOUR_INSTANCE.salesforce.com/services/data/v68.0/connect/scheduling/service-appointments

Where YOUR_INSTANCE is a variable.

Sample Request

Pass the appointment ID as serviceAppointmentId and the resource ID of the actual resource as serviceResourceId in the request. To indicate that the appointment is scheduled, set status to Scheduled.

1{
2  "schedulingPolicyId": "0VrS70000004CEhKAM",
3  "serviceAppointmentId": "08pS70000000CxOIAU",
4  "serviceAppointment": {
5    "serviceTerritoryId": "0HhS70000004F9zKAE",
6    "extendedFields": [
7      {
8        "name": "status",
9        "value": "Scheduled"
10      }
11    ]
12  },
13  "assignedResources": [
14    {
15      "serviceResourceId": "0HnS700000007xwKAA",
16      "isRequiredResource": "true"
17    }
18  ]
19}

Sample Response

The API returns the service appointment ID and the assigned service resources.

1{
2  "result": {
3    "assignedResourceIds": [
4      "03rS70000000406IAA"
5    ],
6    "serviceAppointmentId": "08pS70000000CxOIAU"
7  }
8}

For each service appointment ID that you want to modify, run the PATCH request.

Assign active resources to all customers by modifying the appointments booked against the dummy resource. Usually, Business Location Manager or the person who assigns actual resources performs the modification.

Ensure that the total number of dummy appointments doesn’t exceed the total number of available resources for a time slot. Otherwise, when modifying appointments, one requires to update the time slots based on availability. To avoid these scenarios, configure the Concurrent Scheduling Max appointment slots to around 60–80% of total resource capacity.
Important

The request modifies the service appointment with a new service resource.