DELETE Appointments
Cancel an appointment
Request Information
URI Parameters
None.
Body Parameters
Cancellation information
AppointmentCancel| Name | Description | Type | Additional information |
|---|---|---|---|
| ProcessId |
Process ID of the appointment to cancel. |
integer |
None. |
| UserId |
User Id of rescheduler (typically 1 = System Admin/API) |
integer |
None. |
| CancellationReasonId |
Cancellation Reason Id. If 0 or nothing passed, the system will use the first CancellationReason's ID found. |
integer |
None. |
| CancellationReasonExtRef | string |
None. |
|
| CancellationComment |
Cancellation Comment |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"ProcessId": 1,
"UserId": 2,
"CancellationReasonId": 3,
"CancellationReasonExtRef": "sample string 4",
"CancellationComment": "sample string 5"
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Cancellation information
AppointmentCancel| Name | Description | Type | Additional information |
|---|---|---|---|
| ProcessId |
Process ID of the appointment to cancel. |
integer |
None. |
| UserId |
User Id of rescheduler (typically 1 = System Admin/API) |
integer |
None. |
| CancellationReasonId |
Cancellation Reason Id. If 0 or nothing passed, the system will use the first CancellationReason's ID found. |
integer |
None. |
| CancellationReasonExtRef | string |
None. |
|
| CancellationComment |
Cancellation Comment |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ProcessId": 1,
"UserId": 2,
"CancellationReasonId": 3,
"CancellationReasonExtRef": "sample string 4",
"CancellationComment": "sample string 5"
}