PATCH Appointments

Reschedule an existing (future) appointment. If the appointment is part of a group/family appointment, all appointments are rescheduled in sequence starting with the time provided. The first person of the group will get the start time. If rescheduling the 2nd person, they will get the next time slot after the first start time.

Request Information

URI Parameters

None.

Body Parameters

Reschedule information

AppointmentReschedule

Name	Description	Type	Additional information
OriginalProcessId	Original Process ID to be rescheduled	integer	Required
CancellationReasonId	Reschedule (Cancellation) Reason ID. If 0 or nothing passed, the system will use the first CancellationReason's ID found.	integer	None.
CancellationComment	Reschedule (Cancellation) Comment	string	None.
ProcessId	Process ID populated after appointment rescheduled successfully. Ignored if set prior. This is the best internal reference to the appointment. Must be used for all internal references to the appointment.	integer	None.
CaseId	Case ID populated after appointment rescheduled successfully. Ignored if set prior. This is typically used as the booking reference as it is the easiest number to reference and see in QFlow.	integer	None.
AppointmentDateTime	Appointment Date and Time	date	Required
ServiceId	Service ID if changing service. If nothing passed, the previous service will be used.	integer	None.
AppointmentTypeId	Appointment Type ID if changing the type. If nothing passed, the previous appointment type will be used.	integer	None.
Subject	Subject. Will be copied from previous appointment if nothing passed.	string	None.
Notes	Notes. (Will NOT be copied from previous appointment)	string	None.
ExtRef	Case External Reference. Will be copied from previous appointment if nothing passed.	string	Max length: 200
ReservedSlotId	Pre-Reserved Slot Id (aka Slot Ordinal Number)	integer	None.
UserId	User Id of rescheduler (typically 1 = System Admin/API)	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "OriginalProcessId": 1,
  "CancellationReasonId": 2,
  "CancellationComment": "sample string 3",
  "ProcessId": 4,
  "CaseId": 5,
  "AppointmentDateTime": "2025-09-13T08:23:25.52286+10:00",
  "ServiceId": 7,
  "AppointmentTypeId": 8,
  "Subject": "sample string 9",
  "Notes": "sample string 10",
  "ExtRef": "sample string 11",
  "ReservedSlotId": 12,
  "UserId": 13
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Reschedule information plus CaseId, ProcessId

AppointmentReschedule

Name	Description	Type	Additional information
OriginalProcessId	Original Process ID to be rescheduled	integer	Required
CancellationReasonId	Reschedule (Cancellation) Reason ID. If 0 or nothing passed, the system will use the first CancellationReason's ID found.	integer	None.
CancellationComment	Reschedule (Cancellation) Comment	string	None.
ProcessId	Process ID populated after appointment rescheduled successfully. Ignored if set prior. This is the best internal reference to the appointment. Must be used for all internal references to the appointment.	integer	None.
CaseId	Case ID populated after appointment rescheduled successfully. Ignored if set prior. This is typically used as the booking reference as it is the easiest number to reference and see in QFlow.	integer	None.
AppointmentDateTime	Appointment Date and Time	date	Required
ServiceId	Service ID if changing service. If nothing passed, the previous service will be used.	integer	None.
AppointmentTypeId	Appointment Type ID if changing the type. If nothing passed, the previous appointment type will be used.	integer	None.
Subject	Subject. Will be copied from previous appointment if nothing passed.	string	None.
Notes	Notes. (Will NOT be copied from previous appointment)	string	None.
ExtRef	Case External Reference. Will be copied from previous appointment if nothing passed.	string	Max length: 200
ReservedSlotId	Pre-Reserved Slot Id (aka Slot Ordinal Number)	integer	None.
UserId	User Id of rescheduler (typically 1 = System Admin/API)	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "OriginalProcessId": 1,
  "CancellationReasonId": 2,
  "CancellationComment": "sample string 3",
  "ProcessId": 4,
  "CaseId": 5,
  "AppointmentDateTime": "2025-09-13T08:23:25.52286+10:00",
  "ServiceId": 7,
  "AppointmentTypeId": 8,
  "Subject": "sample string 9",
  "Notes": "sample string 10",
  "ExtRef": "sample string 11",
  "ReservedSlotId": 12,
  "UserId": 13
}