PUT Appointments

Create New Appointment

Request Information

URI Parameters

None.

Body Parameters

Appointment Create Information

Name	Description	Type	Additional information
ProcessId	Process ID populated after creating appointment 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 creating appointment 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.
ServiceId	Service ID which the calendar is attached to.	integer	Required
AppointmentDateTime	Appointment Date and Time (or start date if BookFirstAvailable = true)	date	Required
CustomerId	Customer ID	integer	Required
AppointmentTypeId	Appointment Type ID. If you pass 0 or didn't pass anything, then system will get the first appointment type for the Service. If this is the case, this parameter will be set by the system in the return object.	integer	None.
Subject	Subject	string	Max length: 150
Notes	Notes	string	Max length: 4000
ExtRef	Case External Reference	string	Max length: 200
Classifications	List of Classification Codes	Collection of string	Max length: 20
LanguageCode	Language Code	string	Max length: 6
ReservedSlotId	Pre-Reserved Slot Id (aka Slot Ordinal Number)	integer	None.
UserId	User Id of creator (typically 1 = System Admin/API)	integer	None.
BookFirstAvailable	Book First Available slot. AppointmentDateTime=start date; DaysToSearch=Days to look ahead	boolean	None.
DaysToSearch	If BookFirstAvailableDay=true, check this number of days to look ahead for vacancies	integer	None.
BookFirstAvailMondays	If BookFirstAvailableDay=true, check Mondays in the search for first available	boolean	None.
BookFirstAvailTuesdays	If BookFirstAvailableDay=true, check Tuesdays in the search for first available	boolean	None.
BookFirstAvailWednesdays	If BookFirstAvailableDay=true, check Wednesdays in the search for first available	boolean	None.
BookFirstAvailThursdays	If BookFirstAvailableDay=true, check Thursdays in the search for first available	boolean	None.
BookFirstAvailFridays	If BookFirstAvailableDay=true, check Fridays in the search for first available	boolean	None.
BookFirstAvailSaturdays	If BookFirstAvailableDay=true, check Saturdays in the search for first available	boolean	None.
BookFirstAvailSundays	If BookFirstAvailableDay=true, check Sundays in the search for first available	boolean	None.
CustomProperties	Collection of all custom properties for this appointment process	Dictionary of string [key] and string [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "ProcessId": 1,
  "CaseId": 2,
  "ServiceId": 3,
  "AppointmentDateTime": "2025-06-26T17:45:54.5259337+10:00",
  "CustomerId": 5,
  "AppointmentTypeId": 6,
  "Subject": "sample string 7",
  "Notes": "sample string 8",
  "ExtRef": "sample string 9",
  "Classifications": [
    "sample string 1",
    "sample string 2"
  ],
  "LanguageCode": "sample string 10",
  "ReservedSlotId": 11,
  "UserId": 12,
  "BookFirstAvailable": true,
  "DaysToSearch": 14,
  "BookFirstAvailMondays": true,
  "BookFirstAvailTuesdays": true,
  "BookFirstAvailWednesdays": true,
  "BookFirstAvailThursdays": true,
  "BookFirstAvailFridays": true,
  "BookFirstAvailSaturdays": true,
  "BookFirstAvailSundays": true,
  "CustomProperties": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Creation information plus CaseId, ProcessId, AppointmenTypeId (if not already set)

AppointmentCreation

Name	Description	Type	Additional information
ProcessId	Process ID populated after creating appointment 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 creating appointment 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.
ServiceId	Service ID which the calendar is attached to.	integer	Required
AppointmentDateTime	Appointment Date and Time (or start date if BookFirstAvailable = true)	date	Required
CustomerId	Customer ID	integer	Required
AppointmentTypeId	Appointment Type ID. If you pass 0 or didn't pass anything, then system will get the first appointment type for the Service. If this is the case, this parameter will be set by the system in the return object.	integer	None.
Subject	Subject	string	Max length: 150
Notes	Notes	string	Max length: 4000
ExtRef	Case External Reference	string	Max length: 200
Classifications	List of Classification Codes	Collection of string	Max length: 20
LanguageCode	Language Code	string	Max length: 6
ReservedSlotId	Pre-Reserved Slot Id (aka Slot Ordinal Number)	integer	None.
UserId	User Id of creator (typically 1 = System Admin/API)	integer	None.
BookFirstAvailable	Book First Available slot. AppointmentDateTime=start date; DaysToSearch=Days to look ahead	boolean	None.
DaysToSearch	If BookFirstAvailableDay=true, check this number of days to look ahead for vacancies	integer	None.
BookFirstAvailMondays	If BookFirstAvailableDay=true, check Mondays in the search for first available	boolean	None.
BookFirstAvailTuesdays	If BookFirstAvailableDay=true, check Tuesdays in the search for first available	boolean	None.
BookFirstAvailWednesdays	If BookFirstAvailableDay=true, check Wednesdays in the search for first available	boolean	None.
BookFirstAvailThursdays	If BookFirstAvailableDay=true, check Thursdays in the search for first available	boolean	None.
BookFirstAvailFridays	If BookFirstAvailableDay=true, check Fridays in the search for first available	boolean	None.
BookFirstAvailSaturdays	If BookFirstAvailableDay=true, check Saturdays in the search for first available	boolean	None.
BookFirstAvailSundays	If BookFirstAvailableDay=true, check Sundays in the search for first available	boolean	None.
CustomProperties	Collection of all custom properties for this appointment process	Dictionary of string [key] and string [value]	None.

Response Formats

application/json, text/json

Sample:

{
  "ProcessId": 1,
  "CaseId": 2,
  "ServiceId": 3,
  "AppointmentDateTime": "2025-06-26T17:45:54.666571+10:00",
  "CustomerId": 5,
  "AppointmentTypeId": 6,
  "Subject": "sample string 7",
  "Notes": "sample string 8",
  "ExtRef": "sample string 9",
  "Classifications": [
    "sample string 1",
    "sample string 2"
  ],
  "LanguageCode": "sample string 10",
  "ReservedSlotId": 11,
  "UserId": 12,
  "BookFirstAvailable": true,
  "DaysToSearch": 14,
  "BookFirstAvailMondays": true,
  "BookFirstAvailTuesdays": true,
  "BookFirstAvailWednesdays": true,
  "BookFirstAvailThursdays": true,
  "BookFirstAvailFridays": true,
  "BookFirstAvailSaturdays": true,
  "BookFirstAvailSundays": true,
  "CustomProperties": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}