Schedule Service Appointment
Schedules a service appointment based on the scheduling policy ID and the service appointment ID.
This action is available in API version 62.0 and later.
Supported REST HTTP Methods
URI: /services/data/vXX.X/actions/standard/scheduleServiceAppointment
Where XX.X is the latest API version.
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer TOKEN
Where TOKEN is a variable.
Inputs
| Input | Type | Description |
|---|
serviceAppointmentId | id | Required. The ID of the service appointment to schedule. |
schedulingPolicyId | id | Required. The scheduling policy ID to use to schedule the service appointment. |
Outputs
| Output | Type | Description |
|---|
serviceAppointmentId | string | If the scheduling succeeds, it returns the ID of the scheduled service appointment. |
Example
Sample request body:
1{
2 "inputs" : [{
3 "serviceAppointmentId" : "08p000000000001AAA",
4 "schedulingPolicyId" : "0Vr000000000001AAA"
5 }]
6}
Sample response body:
1{
2 "actionName" : "scheduleServiceAppointment",
3 "errors" : null,
4 "isSuccess" : true,
5 "outputValues" : {
6 "serviceAppointmentId" : "08p000000000001AAA"
7 }
8}