Appointment

Table:
appointment
Model Version:
c93215c2d8b604d9
JSON Schema:
Appointment
allDay
boolean
cancellationNote
Nullable
string
if the appointment was canceled
chatBotSessionId
Nullable
string
if the appointment was created via a chatbot session, this will be the related session
color
aqua, black, blue, brown, gray, green, orange, purple, red, yellow
Color for the appointment
companyId
string
confirmationStatus
Confirmed, Declined, NoResponse
AppointmentConfirmationStatus, this is NOT related to sendConfirmation, confirmationText or confirmationSubject
confirmationSubject
Nullable
string
confirmationText
Nullable
string
createdDate
date-time
Date and time when this appointment was created
customerEmailId
Nullable
string
customerId
Nullable
string
customerPhoneNumberId
Nullable
string
duration
Nullable
integer
the calculated duration
endDate
date-time
end date and time of the appointment
id
Primary Key
string
locationId
string
metadata
Nullable
object
metadata reserved for customers to control
name
string
name of the appointment like 'Oil change'
note
string
notes for the appointment
orderId
Nullable
string
origin
Shop, HQ, AppointmentScheduler
publicId
string
reminderSubject
Nullable
string
reminderText
Nullable
string
removedFromRecurrency
boolean
rruleset
Nullable
string
sendConfirmation
boolean
Send confirmation notification at the moment of saving the appointment
sendReminder
boolean
Send reminder will send a notification at some user-specified times before the appointment using scheduler
startDate
date-time
start date and time of the appointment
updatedDate
Nullable
date-time
useEmail
boolean
In case we want to use email to send confirmation and/or reminder
useSMS
boolean
In case we want to use email to send confirmation and/or reminder
vehicleId
Nullable
string