Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
topOfPage
topOfPage
The Scheduler Preference API is used to access and modify the schedulerPreference object on your business' account. A business' scheduler preferences are used to determine the settings of that business' account.


Info
titleOn this page

Table of Contents





Scheduler Preference API Endpoints


These are the endpoints that are available under the /schedulerPreference path, which allows you to view or modify the scheduler preferences schedulerPreference object on your business' account. 

Endpoint

Description

GET /schedulerPreference

Returns a the schedulerPreference object for your business' account.

PUT /miniwebsiteschedulerPreference

Updates the schedulerPreference object on your business' account.

Request body/payload:  Must pass a schedulerPreference object in the request body/payload. 

For these calls, you need to pass a schedulerPreference object with all required fields and any fields you want to update filled in the body of the payload. We have an example of a schedulerPreference object in the responses section below and have indicated the required fields in the object values table at the bottom of this page.

Return to top





Scheduler Preference API Parameters

There are no parameters associated with schedulerPreference calls.




Scheduler Preference API Responses


Code Block
languagejs
titleGET /schedulerPreference
linenumberstrue
collapsetrue
{
    "acceptPaymentOnBooking": true,
    "additionalGuestText": "Additional Guests",
    "allowTZChangeaddressReq": -1,
    "appModeallowAddConnectedClient": 1true,
    "appointmentDetailTextallowClientAddressValidation": null,
    "appointmentFieldListallowPrintConfirmation": nullfalse,
    "apptDayMaxallowTZChange": 901,
    "apptHrMinappMode": 1,
    "askClientSMSRemindappointmentDetailText": true (HTML text for appointment detail),
    "autoAdvanceWhenSingleappointmentFieldList": false,[
    "bookNewApptLabel": "Book a New Appointment"%BUSINESS_NAME%", 
   "businessId": 43111     "%APPT_STAFF_START_DATE_FULL%"
    ],
    "cancelBtnLabelappointmentListStatuses": "Cancel[
        "OPEN",
 
  "cancelHrs": 1,     "cancelReasonOptional": null,COMPLETED", 
       "cancelledApptBtnLabel": "CancelledCANCELLED", 
        "cancelledApptTitle": "Cancelled Appointments"NO_SHOW"
    ],
    "classCalendarapptDayMax": true180,
    "classDayMaxapptHrMin": 900,
    "classHrMinaskClientSMSRemind": 1true,
    "classMaxSeatautoAdvanceWhenSingle": 40false,
    "classMinSeatautoTranslateDefaultLabels": 0true,
    "clientBlacklistErrorbookMultipleAppointments": "Thefalse,
email address you have entered has been put on our list of blocked clients. At this time, you cannot create an appointment with our office. Thank you","bookNewApptLabel": "Book a New Appointment",
    "booleanJSON": "{\"autoAdvanceWhenSingle\":true}"
    "booleanMap": {
        "clientBlacklistModeallowWaitlistRegistrationOutsideOfAvailability": "GOBBLE"false,
 
  "clientCancelTimeframeError": null,     "completedApptBtnLabelautoProgressToPaymentPortal": "Completed",true,
        "completedApptTitlebusinessInfoVisible": "Completed Appointments", true,
        "continueShoppingUrlcancelReasonList": nullfalse,
        "createdDatedefaultSMSRemindValue": 1522268785000false,
        "createdUserpolicyVisible": nullfalse,
        "currencyshowJoinWaitlistTab": null,
    "defaultScheduler": true,
    "expiredInvitationTextshowPackagesTab": null,
        "filterButtonskipWelcome": "Search",false
        "filterHinttimePnlAutoSelectTime": nulltrue,
        "filterLabeltimePnlShowTimezones": null
"Filter  by zip code:"},
    "filterModebusinessId": 243111,
    "firstDayOfWeekcalendarEngine": 16,
    "hidePricecancelBtnLabel": false"Cancel",
    "infoTextcancelHrs": null1,
    "infoTitlecancelReasonList": "Your Information"null,
    "labelBackcancelReasonOptional": "Back"null,
    "labelBookAnothercancelledApptBtnLabel": "Book another appointmentCancelled",
    "labelJsoncancelledApptTitle": "Cancelled nullAppointments",
    "labelMapclassCalendar": nulltrue,
    "labelNextclassDayMax": "Next"90,
    "labelNoPreferenceclassHrMin": "* No Preference *"1,
    "labelSaveclassMaxSeat": "Save"40,
    "locationGroupTextclassMinSeat": null0,
    "locationGroupTitleclientBlacklistError": null,"The email address you have "locationSuperGroupText": null,
    "locationSuperGroupTitle": null,
    "locationText: "<p>test</p>entered has been put on our list of blocked clients. At this time, you cannot create an appointment with our office. Thank you",
    "locationTitleclientBlacklistMode": "LocationGOBBLE",
    "loggedInWelcomeTextclientCancelTimeframeError": "<div style='text-align:center;'><p>Now that you've logged into our scheduler, you can:↵<ul><li>Schedule a new appointment</li><li>View and manage past and future appointments</li></p><p>Select a button below to get started:</p></div>null,
    "clientReminderSMSHoursList": null,
    "commentsReq": 0,
    "companyReq": -1,
    "completedApptBtnLabel": "Completed",
    "loggedinWelcomeScreencompletedApptTitle": "Completed falseAppointments",
    "loginReqcontinueShoppingUrl": 0null,
    "logoutLabelcountyReq": "Logout"-1,
    "lookBusycouponReq": false0,
    "maxActiveApptClientcreatedDate": -11522268785000,
    "maxAdditionalGuestscreatedUser": 0null,
    "maxClassescurrency": null,
    "maxClientRescheduleCountdebug": nullfalse,
    "modifiedDateemailReq": 15423862340001,
    "modifiedUserexpiredInvitationText": "JoeSchmo"null,
    "noAppointmentTextfilterButton": "Search"All,
 appointment times are currently reserved. Please check back again later.""filterDistanceMeters": null,
    "filterHint": null,
    "noStaffErrorfilterLabel": "ThereFilter isby currently no availability for you to make an appointment through this scheduler. Please check back again later.zip code:",
    "noshowApptBtnLabelfilterMode": "No Show"2,
    "noshowApptTitlefirstDayOfWeek": "No Show Appointments"1,
    "onlyAllowBookingByInvitationfullNameShow": false,
    "openApptTitleheight": "Open appointments"null,
    "payByCreditCardhidePrice": false,
    "poweredByhintMobile": null,
    "preventDupClassBookinghintPhone": null,
    "quotaFullMsginfoBookingSummary": null,
    "recurringClassinfoBookingSummaryWaitlist": false,"Joining wait list for %REASON% "rescheduleBtnLabel": "Rescheduleon %WAITLIST_DATE_LIST",
    "rescheduleHrsinfoText": 1null,
    "restrictReschedToSameStaffinfoTitle": false"Your Information",
    "schedButtonsTopNavlabelBack": false"Back",
    "schedulerLinklabelBookAnother": null "Book another appointment",
    "schedulerPreferenceFieldDefnListlabelCompany": [{schedulerPreferenceFieldDefnId: 375724, businessId: 43111, code: "UDF", dataType: "TXT",…},…],"Company",
    "labelCreditCard": "Pay Now",
    "schedulerPrefernceIdlabelEmail": 36450"Email",
    "selectStaffSortedlabelFirstName": "First falseName",
    "serviceGroupTextlabelJson": null (JSON text for business labels),
    "serviceGroupTitlelabelLastName": "ServiceLast GroupName",
    "serviceSuperGroupTextlabelMap": null,{
        "serviceSuperGroupTitleadditionalGuestText": null"Additional Guests",
        "serviceTextappointmentDetailText": null (HTML text for appointment detail),
        "serviceTitlebookNewApptLabel": "ServiceBook a New Appointment",
    "shortDayList": null,     "shortMonthListbusinessInfoText": null,(HTML text for business  "showAltTimeslot": 0,info),
        "showBookAnothercancelBtnLabel": true"Cancel",

   "showClassOnLocationTab": false,     "showClassRoomOnTimePanelcancelledApptBtnLabel": null"Cancelled",

   "showClientInvoices": false,     "showDurationcancelledApptTitle": true"Cancelled Appointments",
    "showLocationMap": true,
    "showOnlyStartTimeclientBlacklistError": true,"The email address you have "showOpenSlots": true,
    "showServiceGroup": false,
    "showServiceSuperGroup": false,
    "showStaffGroup": false,
    "smsHint": null,entered has been put on our list of blocked clients. At this time, you cannot create an appointment with our office.",
        "staffGroupTextcompletedApptBtnLabel": null"Completed",
 
  "staffGroupTitle": null,     "staffNoPreferencecompletedApptTitle": -1"Completed Appointments",
        "staffTextexpiredInvitationText": null,"This invitation has expired",
        "staffTitlefilterButton": "StaffSearch",
        "thanksCoursesfilterLabel": "<p><strong>YourFilter registrationby for %REASON% is successful</strong><br/> <br />Staff: %STAFF_FULLNAME%<br />Set: %SET_NAME%<br /> <br />Location: %LOCATION_NAME%<br />%LOCATION_ADDRESS%</p>",zip code:",
        "headerText": "Dog Groomers Anonymous!",
        "thanksInfoinfoBookingSummaryWaitList": "<br><br><b>YourJoining appointmentwait haslist been scheduled!</b><br> <br>Staff:  %STAFF_FULLNAME%<br>Time: %APPT_DATE_TIME%<br>Service: %REASON%<br> <BR>Location:  %LOCATION_NAME%<br>%LOCATION_ADDRESS%<BR>",for %REASON% on %WAITLIST_DATE_LIST%",
        "thanksInfoConfirminfoText": "<p>Client</p>"Your,
appointment is awaiting staff confirmation. You will receive an email shortly to let you know whether the staff person has confirmed or declined your appointment request.","infoTitle": "Your Information",
        "labelBack": "Back",
        "thanksInfoPaymentlabelBookAnother": "<br><br><b>YourBook another appointment",
is not yet scheduled.</b><br> <br>Please click on the button below to make payment. Failure to do that will result in cancellation of your appointment.<br>%PAYMENT_BUTTON%","labelCompany": "Company",
        "labelEmail": "Email",
        "thanksPaymentTitlelabelFirstName": "PayFirst NowName",
        "thanksTitlelabelLastName": "ThankLast You!Name",
        "thanksWaitListTitlelabelName": "Full Name"You,
are on the Waitlist",     "timeFormat24HrslabelNext": false,"Next",
        "timeText"labelSave: null"Save",
        "timeTitlelocationGroupText": "Time<p>Group</p>",

   "timezone": null,     "upcomingApptBtnLabellocationGroupTitle": "Upcominggroup title",
        "viewApptLabellocationSuperGroupTitle": "ViewLocation Super AppointmentsGroup",
        "viewInvoiceLabellocationText": "View Invoices",
        "waitListAcceptScreenHeaderlocationTitle": "Claim AppointmentLocation",
        "waitListAcceptScreenTextloggedInWelcomeText": "If you would like to claim the appointment with %STAFF_FULLNAME% at %LOCATION_NAME% for %REASON% on %APPT_DATE_TIME%, please click the confirm button.",<div style=\"text-align:center\"><p>Now that you've logged into our scheduler, you can:\n</p><ul><li>Schedule a new appointment</li><li>View and manage past and future appointments</li><p></p><p>Select a button below to get started:</p></ul></div>",
        "waitListFirstAvailablelogoutLabel": false,"Logout",
        "waitListFirstAvailableTextmetaDescription": "ClickSchedule here to get notified on first available opening",a session!",
        "waitListSuccessTextnoAppointmentText": "YouAll haveappointment beentimes addedare tocurrently thereserved. waitingPlease list.check Shouldback an appointment become available you will be contacted by email or phone.",
    "waitListText": "Click here to join the Wait List for another date/time.",
    "welcomeText": "<font size='5'>Please click through the next few screens to select an appropriate time slot for your appointment.<BR/> Once your appointment is set, you will receive an email confirmation. You will also get a reminder email 24 hours before your appointment.<BR/> Thank You!<BR/></font>",
    "welcomeTitle": "Welcome",
}
Code Block
languagejs
titlePUT /schedulerPreference
linenumberstrue
collapsetrue
{
    "acceptPaymentOnBooking": true,
    "additionalGuestText": "Additional Guests",
    "allowTZChange": 1,
    "appMode": 1,
    "appointmentDetailText": null,
    "appointmentFieldList": null,
    "apptDayMax": 90,
    "apptHrMin": 1,
    "askClientSMSRemind": true,
    "autoAdvanceWhenSingle": false,
    "bookNewApptLabel": "Book a New Appointment",
    "businessId": 43111,
    "cancelBtnLabel": "Cancel",
    "cancelHrs": 1,
    "cancelReasonOptional": null,
    "cancelledApptBtnLabel": "Cancelled",
    "cancelledApptTitle": "Cancelled Appointments",
    "classCalendar": true,
    "classDayMax": 90,
    "classHrMin": 1,
    "classMaxSeat": 40,
    "classMinSeat": 0,
    "clientBlacklistError": "The email address you have entered has been put on our list of blocked clients. At this time, you cannot create an appointment with our office. Thank you",
    "clientBlacklistMode": "GOBBLE",
    "clientCancelTimeframeError": null,
    "completedApptBtnLabel": "Completed",
    "completedApptTitle": "Completed Appointments",
    "continueShoppingUrl": null,
    "couponReq": 0,
    "createdDate": 1522268785000,
    "createdUser": null,
    "currency": null,
    "defaultScheduler": true,
    "expiredInvitationText": null,
    "filterButton": "Search",
    "filterHint": null,
    "filterLabel": "Filter by zip code:",
    "filterMode": 2,
    "firstDayOfWeek": 1,
    "hidePrice": false,
    "infoText": null,
    "infoTitle": "Your Information",
    "labelBack": "Back",
    "labelBookAnother": "Book another appointment",
    "labelJson": null,
    "labelMap": null,
    "labelNext": "Next",
    "labelNoPreference": "* No Preference *",
    "labelSave": "Save",
    "locationGroupText": null,
    "locationGroupTitle": null,
    "locationSuperGroupText": null,
    "locationSuperGroupTitle": null,
    "locationText": "<p>test</p>",
    "locationTitle": "Location",
    "loggedInWelcomeText": "<div style='text-align:center;'><p>Now that you've logged into our scheduler, you can:↵<ul><li>Schedule a new appointment</li><li>View and manage past and future appointments</li></p><p>Select a button below to get started:</p></div>",
    "loggedinWelcomeScreen": false,
    "loginReq": 0,
    "logoutLabel": "Logout",
    "lookBusy": false,
    "maxActiveApptClient": -1,
    "maxAdditionalGuests": 0,
    "maxClasses": null,
    "maxClientRescheduleCount": null,
    "modifiedDate": 1542386234000,
    "modifiedUser": "JoeSchmo",
    "noAppointmentText": "All appointment times are currently reserved. Please check back again later.",
    "noStaffError": "There is currently no availability for you to make an appointment through this scheduler. Please check back again later.",
    "noshowApptBtnLabel": "No Show",
    "noshowApptTitle": "No Show Appointments",
    "onlyAllowBookingByInvitation": false,
    "openApptTitle": "Open appointments",
    "payByCreditCard": false,
    "poweredBy": null,
    "preventDupClassBooking": null,
    "quotaFullMsgagain later.",
        "noStaffError": "There is currently no availability for you to make an appointment through this scheduler. Please check back again later!",
        "noshowApptBtnLabel": "No Show",
        "noshowApptTitle": "No Show Appointments",
        "openApptTitle": "Open appointments",
        "pageTitle": "Dog Groomers Anonymous",
        "policyText": "<h4>Policies & Procedures</h4> <p>Cancellations are allowed up to 24 hours before the appointment start time.</p>",
        "rescheduleBtnLabel": "Reschedule",
        "serviceGroupText": "",
        "serviceGroupTitle": "Service Group",
        "serviceSuperGroupText": "",
        "serviceSuperGroupTitle": "Super Group",
        "serviceText": "<p>Service</p>",
        "serviceTitle": "Service",
        "smsHint": "Message",
        "staffText": "<p>Staff</p>",
        "staffTitle": "Staff",
        "thanksCourses": "<p><strong>Your registration for %REASON% is successful</strong><br /> <br />Staff: %STAFF_FULLNAME%<br />Set: %SET_NAME%<br /> <br />Location: %LOCATION_NAME%<br />%LOCATION_ADDRESS%</p>",
        "thanksInfoConfirm": "<p>Your appointment is awaiting staff confirmation. You will receive an email shortly to let you know whether the staff person has confirmed or declined your appointment request.-</p>",
        "thanksInfoPayment": "<br /><br /><b>Your appointment is not yet scheduled.</b><br /> <br />Please click on the button below to make payment. Failure to do that will result in cancellation of your appointment.<br />%PAYMENT_BUTTON%",
        "thanksInfoPaymentAuthOnly": "<p><br /><br /><strong>Please enter your credit card details using the button below to confirm your appointment.</strong><br /> <br />By clicking on the payment button below you will be prompted to enter your credit card information but no money will be drafted from your card at this time. This is just required in order to hold your appointment.<br />%PAYMENT_BUTTON%</p>",
        "thanksInfoPaymentRequired": "<p><br /><br /><strong>Your appointment is not yet scheduled.</strong><br /> <br />Please click on the button below to make payment. Failure to do that will result in cancellation of your appointment.<br />%PAYMENT_BUTTON%</p>",
        "thanksPaymentTitle": "Pay Now",
        "thanksPaymentTitleAuthOnly": "Authorize Your Card",
        "thanksPaymentTitleRequired": "Pay Now",
        "thanksTitle": "Thank You!",
        "thanksWaitListTitle": "You are on the Waitlist",
        "timeTitle": "Time",
        "upcomingApptBtnLabel": "Upcoming",
        "viewApptLabel": "View Appointments",
        "viewInvoiceLabel": "View Invoices",
        "waitListAcceptScreenHeader": "Claim Appointment",
        "waitListAcceptScreenText": "<p>If you would like to claim the appointment with %STAFF_FULLNAME% at %LOCATION_NAME% for %REASON% on %APPT_DATE_TIME%, please click the confirm button.!</p>",
        "waitListFirstAvailableText": "Click here to get notified on first available opening!",
        "waitListSuccessText": "<p>You have been added to the waiting list. Should an appointment become available you will be contacted by email or phone.!</p>",
        "waitListText": "Click here to join the Wait List for another date/time.!",
        "welcomeText": "<p><span style=\"font-size:x-large\">Please click through the next few screens to select an appropriate time slot for your appointment.<br /> Once your appointment is set, you will receive an email confirmation. You will also get a reminder email 24 hours before your appointment.<br /> Thank You! </span></p>",
        "welcomeTitle": "Welcome"
    },
    "labelName": "Full Name",
    "labelNext": "Next",
    "labelNoPreference": "* No Preference *",
    "labelSave": "Save",
    "labelState": null,
    "recurringClasslabelZip": falsenull,
    "rescheduleBtnLabellocationGroupText": "Reschedule<p>Group</p>",
    "rescheduleHrslocationGroupTitle": "group 1title",
    "restrictReschedToSameStafflocationSuperGroupText": falsenull,
    "schedButtonsTopNavlocationSuperGroupTitle": false,"Location Super    "schedulerLink": nullGroup",
    "schedulerPreferenceFieldDefnList"locationText: [{schedulerPreferenceFieldDefnId: 375724, businessId: 43111, code: "UDF", dataType: "TXT",…},…],"<p>test</p>",
    "locationTitle": "Location",
    "schedulerPrefernceIdloggedInWelcomeText": 36450,
    "selectStaffSorted": false,
    "serviceGroupText": null,
    "serviceGroupTitle": "Service Group",
    "serviceSuperGroupText": null "<div style='text-align:center;'><p>Now that you've logged into our scheduler, you can:↵<ul><li>Schedule a new appointment</li><li>View and manage past and future appointments</li></p><p>Select a button below to get started:</p></div>",
    "serviceSuperGroupTitleloggedInWelcomeScreen": nullfalse,
    "serviceTextloginReq": null0,
    "serviceTitlelogoutLabel": "ServiceLogout",
    "shortDayListlookBusy": nullfalse,
    "shortMonthListmaxActiveApptClient": null-1,
    "showAltTimeslotmaxAdditionalGuests": 0,
    "showBookAnothermaxClasses": truenull,
    "showClassOnLocationTabmaxClientRescheduleCount": falsenull,
    "showClassRoomOnTimePanelmobileReq": null0,
    "showClientInvoicesmodifiedDate": false1542386234000,
    "showDurationmodifiedUser": true"JoeSchmo",
    "showLocationMapname": true,
    "showOnlyStartTime": true"Default",
    "showOpenSlotsnewCustomFields": true,
    "showServiceGroupnoAppointmentText": false,"All appointment times are currently "showServiceSuperGroup": falsereserved. Please check back again later.",
    "showStaffGroupnoStaffError": false,
    "smsHint": null,
    "staffGroupText": null "There is currently no availability for you to make an appointment through this scheduler. Please check back again later.",
    "staffGroupTitlenoshowApptBtnLabel": "No nullShow",
    "staffNoPreferencenoshowApptTitle": -1"No Show Appointments",
    "staffTextonlyAllowBookingByInvitation": nullfalse,
    "staffTitleopenApptTitle": "StaffOpen appointments",
    "thanksCoursespayByCreditCard": "<p><strong>Yourfalse,
registration for %REASON% is successful</strong><br/> <br />Staff: %STAFF_FULLNAME%<br />Set: %SET_NAME%<br /> <br />Location: %LOCATION_NAME%<br />%LOCATION_ADDRESS%</p>" "phoneReq": 0,
    "poweredBy": null,
    "thanksInfoquotaFullMsg": "<br><br><b>Yournull,
appointment has been scheduled!</b><br> <br>Staff:  %STAFF_FULLNAME%<br>Time: %APPT_DATE_TIME%<br>Service: %REASON%<br> <BR>Location:  %LOCATION_NAME%<br>%LOCATION_ADDRESS%<BR>" "recurringClass": false,
    "rejectDupClientPerClass": false,
    "thanksInfoConfirmrescheduleBtnLabel": "Reschedule"Your,
appointment is awaiting staff confirmation. You will receive an email shortly to let you know whether the staff person has confirmed or declined your appointment request." "rescheduleHrs": 1,
    "restrictReschedToSameStaff": false,
    "schedButtonsTopNav": false,
    "schedulerLink": null,
    "thanksInfoPaymentschedulerPreferenceFieldDefnList": "<br><br><b>Your appointment is not yet scheduled.</b><br> <br>Please click on the button below to make payment. Failure to do that will result in cancellation of your appointment.<br>%PAYMENT_BUTTON%"[{Scheduler fields object for scheduler preference fields - for more info, see Scheduler Fields API page}],
    "schedulerPrefernceId": 36450,
    "selectStaffSorted": false,
    "thanksPaymentTitleserviceGroupText": "Pay Now",
    "thanksTitleserviceGroupTitle": "ThankService You!Group",
    "thanksWaitListTitleserviceSuperGroupText": "You are on the Waitlist",
    "timeFormat24HrsserviceSuperGroupTitle": false"Super Group",
    "timeTextserviceText": null"<p>Service</p>",
    "timeTitleserviceTitle": "TimeService",
    "timezoneshortDayList": null,
    "upcomingApptBtnLabelshortMonthList": "Upcoming"null,
    "viewApptLabelshowAddToCalendar": "View Appointments"true,
    "viewInvoiceLabelshowAltTimeslot": "View Invoices"0,
    "waitListAcceptScreenHeadershowBookAnother": "Claim Appointment"true,
    "waitListAcceptScreenTextshowClassOnLocationTab": "Iffalse,
you would like to claim the appointment with %STAFF_FULLNAME% at %LOCATION_NAME% for %REASON% on %APPT_DATE_TIME%, please click the confirm button.""showClassRoomOnTimePanel": null,
    "showClientInvoices": false,
    "showDuration": false,
    "waitListFirstAvailableshowLocationGroup": false,
    "waitListFirstAvailableTextshowLocationMap": "Click here to get notified on first available opening" true,
    "showOnlyStartTime": false,
    "showOpenSlots": true,
    "waitListSuccessTextshowPoweredBy": "Youtrue,
have been added to the waiting list. Should an appointment become available you will be contacted by email or phone.""showServiceGroup": false,
    "showServiceSuperGroup": false,
    "showStaffGroup": false,
    "waitListTextsmsHint": "Message"Click,
  here to join the Wait List for another date/time.""staffGroupText": null,
    "staffGroupTitle": null,
    "welcomeTextstaffNoPreference": "<font size='5'>Please click through the next few screens to select an appropriate time slot for your appointment.<BR/> Once your appointment is set, you will receive an email confirmation. You will also get a reminder email 24 hours before your appointment.<BR/> Thank You!<BR/></font>0,
    "staffText": null,
    "staffTitle": "Staff",
    "thanksCourses": "<p><strong>Your registration for %REASON% is successful</strong><br/> <br />Staff: %STAFF_FULLNAME%<br />Set: %SET_NAME%<br /> <br />Location: %LOCATION_NAME%<br />%LOCATION_ADDRESS%</p>",
    "welcomeTitlethanksInfo": "Welcome",
}

Scheduler Preference Object Values

Property nameTypeDescriptionacceptPaymentOnBookingbooleanIndicates whether or not business is set to accept payment on booking.additionalGuestTextstringDisplays as the label provided for Additional Guests under Client Information.allowTZChange
<br><br><b>Your appointment has been scheduled!</b><br> <br>Staff:  %STAFF_FULLNAME%<br>Time: %APPT_DATE_TIME%<br>Service: %REASON%<br> <BR>Location:  %LOCATION_NAME%<br>%LOCATION_ADDRESS%<BR>",
    "thanksInfoConfirm": "Your appointment is awaiting staff confirmation. You will receive an email shortly to let you know whether the staff person has confirmed or declined your appointment request.",
    "thanksInfoPayment": "<br><br><b>Your appointment is not yet scheduled.</b><br> <br>Please click on the button below to make payment. Failure to do that will result in cancellation of your appointment.<br>%PAYMENT_BUTTON%",
    "thanksInfoPaymentAuthOnly": "<p><br /><br /><strong>Please enter your credit card details using the button below to confirm your appointment.</strong><br /> <br />By clicking on the payment button below you will be prompted to enter your credit card information but no money will be drafted from your card at this time. This is just required in order to hold your appointment.<br />%PAYMENT_BUTTON%</p>",
    "thanksInfoPaymentRequired": "<p><br><br><strong>Your appointment is not yet scheduled.</strong><br> <br>Please click on the button below to make payment. Failure to do that will result in cancellation of your appointment.<br>%PAYMENT_BUTTON%</p>",
    "thanksPaymentTitle": "Pay Now",
    "thanksPaymentTitleAuthOnly": "Authorize your card",
    "thanksPaymentTitleRequired": "Pay Now",
    "thanksTitle": "Thank You!",
    "thanksWaitListTitle": "You are on the Waitlist",
    "timeFormat24Hrs": true,
    "timeLockMinutes": null,
    "timeText": "<p>Time</p>",
    "timeTitle": "Time",
    "timezone": null,
    "titleBgColor": null,
    "titleFontColor": null,
    "upcomingApptBtnLabel": "Upcoming",
    "viewApptLabel": "View Appointments",
    "viewInvoiceLabel": "View Invoices",
    "waitListAcceptScreenHeader": "Claim Appointment",
    "waitListAcceptScreenText": "If you would like to claim the appointment with %STAFF_FULLNAME% at %LOCATION_NAME% for %REASON% on %APPT_DATE_TIME%, please click the confirm button.",
    "waitListFirstAvailable": false,
    "waitListFirstAvailableText": "Click here to get notified on first available opening",
    "waitListSuccessText": "You have been added to the waiting list. Should an appointment become available you will be contacted by email or phone.",
    "waitListText": "Click here to join the Wait List for another date/time.",
    "welcomeText": "<font size='5'>Please click through the next few screens to select an appropriate time slot for your appointment.<BR/> Once your appointment is set, you will receive an email confirmation. You will also get a reminder email 24 hours before your appointment.<BR/> Thank You!<BR/></font>",
    "welcomeTitle": "Welcome",
    "width": null
}


Code Block
languagejs
titlePUT /schedulerPreference
linenumberstrue
collapsetrue
{
    "acceptPaymentOnBooking": true,
    "additionalGuestText": "Additional Guests",
    "allowTZChange": 1,
    "appMode": 1,
    "appointmentDetailText": null,
    "appointmentFieldList": null,
    "apptDayMax": 90,
    "apptHrMin": 1,
    "askClientSMSRemind": true,
    "autoAdvanceWhenSingle": false,
    "bookNewApptLabel": "Book a New Appointment",
    "businessId": 43111,
    "cancelBtnLabel": "Cancel",
    "cancelHrs": 1,
    "cancelReasonOptional": null,
    "cancelledApptBtnLabel": "Cancelled",
    "cancelledApptTitle": "Cancelled Appointments",
    "classCalendar": true,
    "classDayMax": 90,
    "classHrMin": 1,
    "clientBlacklistError": "The email address you have entered has been put on our list of blocked clients. At this time, you cannot create an appointment with our office. Thank you",
    "clientBlacklistMode": "GOBBLE",
    "completedApptBtnLabel": "Completed",
    "completedApptTitle": "Completed Appointments",
    "continueShoppingUrl": null,
    "couponReq": 0,
    "createdDate": 1522268785000,
    "createdUser": null,
    "currency": null,
    "expiredInvitationText": null,
    "filterButton": "Search",
    "filterHint": null,
    "filterLabel": "Filter by zip code:",
    "filterMode": 2,
    "hidePrice": false,
    "infoText": null,
    "infoTitle": "Your Information",
    "labelBack": "Back",
    "labelBookAnother": "Book another appointment",
    "labelJson": null,
    "labelMap": null,
    "labelNext": "Next",
    "labelNoPreference": "* No Preference *",
    "labelSave": "Save",
    "locationGroupText": null,
    "locationGroupTitle": null,
    "locationSuperGroupText": null,
    "locationSuperGroupTitle": null,
    "locationText": "<p>test</p>",
    "locationTitle": "Location",
    "loggedInWelcomeText": "<div style='text-align:center;'><p>Now that you've logged into our scheduler, you can:↵<ul><li>Schedule a new appointment</li><li>View and manage past and future appointments</li></p><p>Select a button below to get started:</p></div>",
    "loginReq": 0,
    "logoutLabel": "Logout",
    "lookBusy": false,
    "maxActiveApptClient": -1,
    "maxAdditionalGuests": 0,
    "maxClientRescheduleCount": null,
    "modifiedDate": 1542386234000,
    "modifiedUser": "JoeSchmo",
    "noAppointmentText": "All appointment times are currently reserved. Please check back again later.",
    "noStaffError": "There is currently no availability for you to make an appointment through this scheduler. Please check back again later.",
    "noshowApptBtnLabel": "No Show",
    "noshowApptTitle": "No Show Appointments",
    "onlyAllowBookingByInvitation": false,
    "openApptTitle": "Open appointments",
    "quotaFullMsg": null,
    "recurringClass": false,
    "rescheduleBtnLabel": "Reschedule",
    "rescheduleHrs": 1,
    "restrictReschedToSameStaff": false,
    "schedButtonsTopNav": false,
    "schedulerPreferenceFieldDefnList": [{schedulerPreferenceFieldDefnId: 375724, businessId: 43111, code: "UDF", dataType: "TXT",…},…],
    "schedulerPrefernceId": 36450,
    "selectStaffSorted": false,
    "serviceGroupText": null,
    "serviceGroupTitle": "Service Group",
    "serviceSuperGroupText": null,
    "serviceSuperGroupTitle": null,
    "serviceText": null,
    "serviceTitle": "Service",
    "showAltTimeslot": 0,
    "showBookAnother": true,
    "showClassOnLocationTab": false,
    "showClassRoomOnTimePanel": null,
    "showClientInvoices": false,
    "showDuration": true,
    "showLocationMap": true,
    "showOnlyStartTime": true,
    "showOpenSlots": true,
    "showServiceGroup": false,
    "showServiceSuperGroup": false,
    "showStaffGroup": false,
    "smsHint": null,
    "staffGroupText": null,
    "staffGroupTitle": null,
    "staffNoPreference": -1,
    "staffText": null,
    "staffTitle": "Staff",
    "thanksCourses": "<p><strong>Your registration for %REASON% is successful</strong><br/> <br />Staff: %STAFF_FULLNAME%<br />Set: %SET_NAME%<br /> <br />Location: %LOCATION_NAME%<br />%LOCATION_ADDRESS%</p>",
    "thanksInfo": "<br><br><b>Your appointment has been scheduled!</b><br> <br>Staff:  %STAFF_FULLNAME%<br>Time: %APPT_DATE_TIME%<br>Service: %REASON%<br> <BR>Location:  %LOCATION_NAME%<br>%LOCATION_ADDRESS%<BR>",
    "thanksInfoConfirm": "Your appointment is awaiting staff confirmation. You will receive an email shortly to let you know whether the staff person has confirmed or declined your appointment request.",
    "thanksInfoPayment": "<br><br><b>Your appointment is not yet scheduled.</b><br> <br>Please click on the button below to make payment. Failure to do that will result in cancellation of your appointment.<br>%PAYMENT_BUTTON%",
    "thanksPaymentTitle": "Pay Now",
    "thanksTitle": "Thank You!",
    "thanksWaitListTitle": "You are on the Waitlist",
    "timeFormat24Hrs": false,
    "timeText": null,
    "timeTitle": "Time",
    "timezone": null,
    "upcomingApptBtnLabel": "Upcoming",
    "viewApptLabel": "View Appointments",
    "viewInvoiceLabel": "View Invoices",
    "waitListAcceptScreenHeader": "Claim Appointment",
    "waitListAcceptScreenText": "If you would like to claim the appointment with %STAFF_FULLNAME% at %LOCATION_NAME% for %REASON% on %APPT_DATE_TIME%, please click the confirm button.",
    "waitListFirstAvailable": false,
    "waitListFirstAvailableText": "Click here to get notified on first available opening",
    "waitListSuccessText": "You have been added to the waiting list. Should an appointment become available you will be contacted by email or phone.",
    "waitListText": "Click here to join the Wait List for another date/time.",
    "welcomeText": "<font size='5'>Please click through the next few screens to select an appropriate time slot for your appointment.<BR/> Once your appointment is set, you will receive an email confirmation. You will also get a reminder email 24 hours before your appointment.<BR/> Thank You!<BR/></font>",
    "welcomeTitle": "Welcome",
}





Scheduler Preference Object Values


schedulerPreference

Property nameTypeDescription
acceptPaymentOnBookingbooleanIndicates whether or not the business is set to accept payment on booking.
additionalGuestTextstringDisplays as the label provided for Additional Guests under Client Information.
allowTZChangeintegerDisplays as what is set for Client Timezones under Time Setting - a value of -1 indicates that it is set to "Allow clients to change timezones", a value of 0 that it's set to "Do not allow clients to change timezones", and a value of 1 that it's set to "Do not show timezones to clients".
appModeintegerCorresponds with the Panel Flow setting under Scheduler Rules & Logic - for more info on the different appMode settings, see the appMode key below.
appointmentDetailTextstringDisplays as what is set to show on the Appointment Detail Page under Mini Website Design.
appointmentFieldListarrayDisplays an array of strings that have been added to the Appointment List Columns under Mini Website Design.
apptDayMaxintegerDisplays as the number of days that the Advanced Service Booking is set to under Service Appointment Time Display.
apptHrMinintegerDisplays as the number of hours that the Latest Appointment is set to under Service Appointment Time Display.
askClientSMSRemindbooleanIndicates whether or not the "Clients can request text message" box is checked under Client Info Settings.
autoAdvanceWhenSinglebooleanIndicates whether or not the Auto Advance box is checked under Scheduler Rules & Logic.
bookNewApptLabelstringDisplays as what is set as the Book a New Appointment Button Label under Mini Website Design.
businessIdintegerProvides unique numeric ID of the business that has specified scheduler preferences.
cancelBtnLabelstringDisplays as what is set as the Cancel Button Label under Mini Website Design.
cancelHrsintegerDisplays as the number of hours that Cancellations is set to under Scheduler Rules & Logic.
cancelReasonOptionalbooleanIndicates whether or not the Cancel Reason Optional box is checked under Scheduler Rules & Logic.
cancelledApptBtnLabelstringDisplays as what is set to show on the Cancelled Appointments Button under Mini Website Design.
cancelledApptTitlestringDisplays as what is set as the Cancelled Appointments Title under Mini Website Design.
classCalendarbooleanIndicates whether or not the Show Monthly Calendar box is checked under Class Time Display.
classDayMaxintegerDisplays as what is set as for Advanced Class Booking under Class Time Display, where 1 month gets treated like 30 days.
classHrMinintegerDisplays as the number of hours that Latest Class is set to under Class Time Display.
clientBlacklistErrorstringDisplays as what is set as Client Blacklist Mode under Client Info Settings. Has available options "GOBBLE" and "BLOCK".
clientBlacklistModestringDisplays as what is set as Client Blacklist Mode under Client Info Settings.
completedApptBtnLabelstringDisplays as the what is set to show on the Completed Appointment Button under Mini Website Design.
completedApptTitlestringDisplays as what is set as the Completed Appointments Title under Mini Website Design.
continueShoppingUrlstringDisplays as what is set as the Button Redirect URL under Confirmation Panel Settings.
couponReqintegerDisplays as the integer associated with whether or not the specified business is set to Accept Coupons on Scheduler under Manage Coupons, where 0 indicates Yes and -1 indicates No.
createdDateintegerDisplays as the date the specified business was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
createdUserstringDisplays as the username of the user who created the specified business.
currencyobjectDisplays as the currency object connected to the specified business - for more info, see Currency API page.
expiredInvitationTextstringDisplays as what is set as the Invitation Campaign Expired Error Message under Messaging Settings.
filterButtonstringDisplays as what is set to show on the Filter Search Button under Scheduler Rules & Logic.
filterHintstringDisplays as what is set as the Filter Hint under Scheduler Rules & Logic.
filterLabelstringDisplays as what is set as the Filter Label under Scheduler Rules & Logic.
filterModeintegerDisplays as what is set for Client Timezones under Time Setting the Zip Code Filter under Scheduler Rules & Logic - a value of -1 indicates that it is set to "Allow clients to change timezones"Do not apply zip code filter, a value of 0 1 indicates that it's set to "Do not allow clients to change timezones"Apply zip code filter to location, and a value of 1 2 indicates that it's set to "Do not show timezones to clients".
appModeintegerCorresponds with the Panel Flow setting under Scheduler Rules & Logic. 
appointmentDetailTextApply zip code filter to staff"
hidePricebooleanIndicates whether or not the Hide Price box is checked under Service & Class Panel Settings.
infoTextstringDisplays as what is set as the Clients Info Header Text under Client Info Settings.
infoTitlestringDisplays as what is set to show on the Appointment Detail Page under Mini Website Design.appointmentFieldListarrayDisplays an array of strings that have been added to the Appointment List Columns as the Clients Info Panel Title under Client Info Settings.
labelBackstringDisplays as what is set as the 'Back' Button Label under Mini Website Design.
apptDayMaxlabelBookAnotherintegerstringDisplays as the number of days that the Advanced Service Booking is set to under Service Appointment Time Display.
apptHrMinintegerDisplays as the number of hours that the Latest Appointment is set to under Service Appointment Time Display.
askClientSMSRemindbooleanIndicates whether or not the "Clients can request text message" box has been checked.
autoAdvanceWhenSinglebooleanIndicates whether or not the Auto Advance box is checked under Scheduler Rules & Logic.
bookNewApptLabelwhat is set as the 'Book Again' Button Label under Confirmation Panel Settings.
labelJsonstringDisplays as a string representation of the JSON object describing the Labels under Client Info Settings.
labelMapobjectShould mimic the properties and values stored on labelJson, just using object representation instead of a string; if you are trying to write values, they must be written to the labelJson property and the backend will take care of translating them to the labelMap property
labelNextstringDisplays as what is set as the Book a New Appointment 'Next' Button Label under Mini under Mini Website Design.
businessIdlabelNoPreferenceintegerProvides unique numeric ID of the business that has specified scheduler preferences.cancelBtnLabelstringDisplays as what is set as the "No preference label" under Staff Panel Settings.
labelSavestringDisplays as what is set as the Cancel 'Save' Button Label under Mini Website DesignClient Info Settings.
cancelHrslocationGroupTextintegerstringDisplays as the number of hours prior to an appointment that clients can cancel.
cancelReasonOptionalbooleanIndicates whether or not the Cancel Reason Optional box is checked under Scheduler Rules & Logic.
cancelledApptBtnLabelwhat is set as the Location Group Header Text under Location Panel Settings.
locationGroupTitlestringDisplays as what is set to show on the Cancelled Appointments Button under Mini Website Design.cancelledApptTitleas the Location Group Panel Title under Location Panel Settings.
locationSuperGroupTextstringDisplays as what is set as the Cancelled Appointments Title under Mini Website Design.
classCalendarbooleanIndicates whether or not the Show Monthly Calendar box is checked under Class Time Display.
classDayMaxintegerDisplays as the maximum number of days that a class can be set up to elapse.
classHrMinintegerDisplays as the number of hours that Latest Class is set to under Class Time Display.
classMaxSeatintegerDisplays as the maximum number of seats available for classes.
classMinSeatintegerDisplays as the minimum number of seats available for classes.
clientBlacklistErrorstringDisplays as what is set as Client Blacklist Mode under Client Info Settings. Has available options "GOBBLE" and "BLOCK".
clientBlacklistModeLocation Super Group Header Text under Location Panel Settings.
locationSuperGroupTitlestringDisplays as what is set as the Location Super Group Panel Title under Location Panel Settings.
locationTextstringDisplays as what is set as the Header Text under Location Panel Settings.
locationTitlestringDisplays as what is set as the Panel Title under Location Panel Settings.
loggedInWelcomeTextstringDisplays as what is set as the Logged In Header Text under Mini Website Design.
loginReqintegerDisplays as what is set for Client Login under Mini Website Design - a value of -1 indicates that it is set to "Don't Allow Clients to Login", a value of 0 that it's set to "Allow Clients to Login", a value of 1 that it's set to "Clients Must Login to Book an Appointment", and a value of 2 that it's set to "Only Registered Clients Can Book an Appointment".
logoutLabelstringDisplays as what is set as Client Blacklist Mode under Client Info Settingsthe Logout Button Label under Mini Website Design.
clientCancelTimeframeErrorlookBusystring
completedApptBtnLabelstringDisplays as the what is set to show on the Completed Appointment Button under Mini Website Design.
completedApptTitlestringDisplays as what is set as the Completed Appointments Title under Mini Website Design.
continueShoppingUrlstringDisplays as what is set as the Button Redirect URL under Confirmation Panel Settings.
couponReqbooleanIndicates whether or not the Look Busy box is checked under Service Appointment Time Display.
maxActiveApptClientintegerDisplays as the number that is set as the "Max number of open appointments" under Mini Website Design.
maxAdditionalGuestsintegerDisplays as the number that is set for Additional Gusts under Client Info Settings.
maxClientRescheduleCountintegerDisplays as the integer associated with whether or not the specified business number of times that the Max Rescheduling Limit is set to Accept Coupons on Scheduler under Manage Coupons, where 0 indicates Yes and -1 indicates No.createdDateunder Scheduler Rules & Logic.
modifiedDateintegerDisplays as the date the specified business was created last modified in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
createdUsermodifiedUserstringDisplays as the username of the user who created the last modified specified business.
currencynoAppointmentTextobjectstringDisplays as the currency object connected to the specified business - for more info, see Currency API page.defaultSchedulerbooleanexpiredInvitationTextas what is set as the "No appointments error message" under Time Panel Settings.
noStaffErrorstringDisplays as what is set as the Invitation Campaign Expired No Staff Error Message under Messaging Staff Panel Settings.
filterButtonnoshowApptBtnLabelstringDisplays as what is set to show the label appearing on the Filter Search Button under Scheduler Rules & Logic.filterHintNo Show Appointment Button under Mini Website Design.
noshowApptTitlestringDisplays as what is set as the Filter Hint set as the No Show Appointments Title under Mini Website Design.
onlyAllowBookingByInvitationbooleanIndicates whether or not the Booking by Invitation Only box has been checked under Scheduler Rules & Logic.
filterLabelopenApptTitlestringDisplays as what is set as the Filter Label under Scheduler Rules & Logic.filterModeintegerfirstDayOfWeekintegerhidePriceOpen Appointments Title under Mini Website Design.
preventDupClassBookingbooleanIndicates whether or not the Hide Price box is checked under Service & Class Panel Settings.
infoTextstringDisplays as what is set as the Clients Info Header Text under Client Info Settings.
infoTitlestringDisplays as what is set as the Clients Info Panel Title under Client Info Settings.
labelBackscheduler is set to check if the client who is booking is already registered for a class session, and will not let them register for the same class session multiple times - this requires that the business account has their clients login to the scheduler.
recurringClassbooleanIndicates whether or not the "Recurring class booking" box is checked under Class Time Display.
rescheduleBtnLabelstringDisplays as what is set as the 'Back' Reschedule Button Label under Mini under Mini Website Design.
labelBookAnotherrescheduleHrsstringintegerDisplays as what the number of hours that Rescheduling is set as the 'Book Again' Button Label under Confirmation Panel Settings.
labelJsonstringDisplays as a string representation of the JSON object describing various Labels under Client Info Settings.
labelMapobjectActs as a map that contains all the labels that have been edited.
labelNextstringDisplays as to under Scheduler Rules & Logic.
restrictReschedToSameStaffbooleanIndicates whether or not the Restrict Rescheduling to Same Staff is checked under Scheduler Rules & Logic.
schedButtonsTopNavbooleanIndicates what is set as the ' Next ' & Back Button Label Position under Mini Website Design, where true indicates "Display in header" and false indicates "Display in footer".
labelNoPreferenceschedulerPreferenceFieldDefnListstringarrayDisplays as what is set as the "No preference label" under Staff Panel Settings.
labelSavestringDisplays as what is set as the 'Save' Button Label under Client Info Settings.
locationGroupTextan array of different schedulerPreferenceFieldDefnId objects that represent the schedulerFields objects - for more info, see Scheduler Fields API page.
schedulerPrefernceIdintegerProvides unique numeric ID for specified scheduler preferences.
selectStaffSortedbooleanIndicates whether or not the Book Staff in Order box is checked under Staff Panel Settings.
serviceGroupTextstringDisplays as what is set as the Location Group Panel Header Text under Location Service & Class Panel Settings.
locationGroupTitleserviceGroupTitlestringDisplays as what is set as the Location Group Panel Title under Location Service & Class Panel Settings.
locationSuperGroupTextserviceSuperGroupTextstringDisplays as what is set as the Location Super super Group Panel Header Text under Location Service & Class Panel Settings.
locationSuperGroupTitleserviceSuperGroupTitlestringDisplays as what is set as the Location Reason Super Group Panel Title under Location Service & Class Panel Settings.
locationTextserviceTextstringDisplays as what is set as the Header Text under Location Panel Settings.locationTitlestringDisplays as what is set as the Panel Title under Location Service & Class Panel Settings.
loggedInWelcomeTextserviceTitlestringDisplays as what is set as the Logged In Header Text under Mini Website Design.loggedinWelcomeScreenbooleanloginReqPanel Title under Service & Class Panel Settings.
showAltTimeslotintegerDisplays as wha what is set for Client Login under Mini Website Design Appointment Start Times under Service Appointment Time Display - a value of -1 0 indicates that it is set to "Don't Allow Clients to Login"Show start times based on service durations", a value of 1 that it's set to "Show start times on the hour", a value of 2 that it's set to "Show start times every 30 minutes (half hour)", a value of 3 that it's set to "Show start times every 15 minutes (quarter hour)", a value of 4 that it's set to "Allow Clients to LoginShow start times every 10 minutes", and a value of 1 5 that it's set to "Clients Must Login to Book an Appointment", and a value of 2 that it's set to "Only Registered Clients Can Book an Appointment".
logoutLabelstringDisplays as what is set as the Logout Button Label under Mini Website Design.
lookBusyShow start times every 5 minutes".
showBookAnotherbooleanIndicates whether or not the Show 'Book Again' Button box is checked under Confirmation Panel Settings.
showClassOnLocationTabbooleanIf the Services & Classes panel appears before the Locations panel in the scheduling flow, this property indicates whether or not the web scheduler will show a list of the class sessions coming up at that location.
showClassRoomOnTimePanelbooleanIndicates whether or not the Look Busy Show Classroom box is checked under Service Appointment Class Time Display.
maxActiveApptClientshowClientInvoicesintegerDisplays as the number that is set as the "Max number of open appointments" under Mini Website Design.
maxAdditionalGuestsintegerDisplays as the number that is set for Additional Gusts under Client Info Settings.
maxClassesinteger
maxClientRescheduleCountintegerDisplays as the number of times that the Max Rescheduling Limit is set to under Scheduler Rules & Logic.
modifiedDateintegerDisplays as date specified business was last modified in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
modifiedUserstringDisplays as username of user who last modified specified business.
noAppointmentTextstringDisplays as what is set as the "No appointments error message" under Time Panel Settings.
noStaffErrorstringDisplays as what is set as the No Staff Error Message under Staff Panel Settings.
noshowApptBtnLabelstringDisplays as the label appearing on the No Show Appointment Button under Mini Website Design.
noshowApptTitlestringDisplays as what is set as the No Show Appointments Title under Mini Website Design.
onlyAllowBookingByInvitationbooleanIndicates whether or not the "Show clients invoices when they login" box has been checked under Payment Settings.
showDurationbooleanIndicates whether or not the Display Duration box is checked under Service & Class Panel Settings.
showLocationMapbooleanIndicates whether or not the Show Location Map View box is checked under Location Panel Settings.
showOnlyStartTimebooleanIndicates whether or not the Show Appointment End Time box is checked under Time Panel Settings.
showOpenSlotsbooleanIndicates whether or not the "Show open class seats" box is checked under Class Time Display.
showServiceGroupbooleanIndicates whether or not the Show Groups in Flow box is checked under Service & Class Panel Settings.
showServiceSuperGroupbooleanIndicates whether or not the Booking by Invitation Only box has been checked under Scheduler Rules & Logic.openApptTitleShow Reason Super Groups in Flow box is checked under Service & Class Panel Settings.
showStaffGroupbooleanNot set up yet
smsHintstringDisplays as what is set as the Open Appointments Title under Mini Website DesignText Message Hint under Client Info Settings.
payByCreditCardstaffGroupTextbooleanpoweredBystringpreventDupClassBookingbooleanquotaFullMsgstring
recurringClassbooleanIndicates whether or not the "Recurring class booking" box is checked under Class Time Display.
rescheduleBtnLabelNot set up yet
staffGroupTitlestringNot set up yet
staffNoPreferenceintegerIndicates whether it is set to Show or Hide 'No Preference' Option under Staff Panel Settings.
staffTextstringDisplays as what is set as the Reschedule Button Label under Mini Website DesignHeader Text under Staff Panel Settings.
rescheduleHrsstaffTitleintegerstringDisplays as the number of hours that Rescheduling what is set to under Scheduler Rules & Logicas the Panel Title under Staff Panel Settings.
restrictReschedToSameStaffthanksCoursesbooleanIndicates whether or not scheduler preference is set to restrict rescheduled appointments to the same staff.schedButtonsTopNavbooleanIndicates stringDisplays as what is set as the Next & Back Button Position under Mini Website Design, where true means "Display in header" and false schedulerLinkstring
schedulerPreferenceFieldDefnListarrayDisplays as an array of different schedulerPreferenceFieldDefnId objects that represent the schedulerFields objects - for more info, see Scheduler Fields API page.
schedulerPrefernceIdintegerProvides unique numeric ID for specified scheduler preferences.
selectStaffSortedbooleanserviceGroupTextAppointment Saved Message (for courses) under Confirmation Panel Settings.
thanksInfostringDisplays as what is set as the Appointment Saved Message under Confirmation Panel Settings.
thanksInfoConfirmstringDisplays as what is set as the Appointment Awaiting Staff Confirmation Message Message under Confirmation Panel Settings.
thanksInfoPaymentstringDisplays as what is set as the Group Panel Header Text under Service & Class Panel Confirmation Message under Payment Settings.
serviceGroupTitlethanksPaymentTitlestringDisplays as what is set as the Group Panel Confirmation Title under Service & Class Panel Payment Settings.
serviceSuperGroupTextthanksTitlestringDisplays as what is set as the super Group Confirmation Panel Header Text under Service & Class Panel Title under Confirmation Pane Settings.
serviceSuperGroupTitlethanksWaitListTitlestringDisplays as what is set as the Reason Super Group Waitlist Confirmation Panel Title under Service & Class Waitlist Settings.
timeFormat24HrsbooleanIndicates whether or not specified the 24 Hour Format box is checked under Time Panel Settings.
serviceTexttimeTextstringDisplays as what is set as the Header Text under Service & Class Time Panel Settings.
serviceTitletimeTitlestringDisplays as what is set as the Panel Title under Service & Class Panel Settings.shortDayListarrayshortMonthListarrayshowAltTimeslotintegershowBookAnotherbooleanIndicates whether or not the Show 'Book Again' Button box is checked under Confirmation Time Panel Settings.
showClassOnLocationTabtimezoneboolean
showClassRoomOnTimePanelbooleanIndicates whether or not the Show Classroom box is checked under Class Time Display.
showClientInvoicesbooleanIndicates whether or not the "Show clients invoices when they login" box has been checked under Payment Settings.
showDurationbooleanIndicates whether or not the Display Duration box is checked under Service & Class Panel Settings.
showLocationMapbooleanIndicates whether or not the Show Location Map View box is checked under Location Panel Settings.
showOnlyStartTimebooleanIndicates whether or not the Show Appointment End Time box is checked under Time Panel Settings.
showOpenSlotsbooleanIndicates whether or not the "Show open class seats" box is checked under Class Time Display.
showServiceGroupbooleanIndicates whether or not the Show Groups in Flow box is checked under Service & Class Panel Settings.
showServiceSuperGroupobjectDisplays the timezone object for timezone of business - for more info, see Timezones API page.
upcomingApptBtnLabelstringDisplays as the label that is set to appear on the Open Appointments Button under Mini Website Design.
viewApptLabelstringDisplays as what is set as the View Appointments Button Label under Mini Website Design.
viewInvoiceLabelstringDisplays as what is set as the View Invoices Button Label under Mini Website Design.
waitListAcceptScreenHeaderstringDisplays as what is set as the Waitlist Appointment Landing Page Header under Waitlist Settings.
waitListAcceptScreenTextstringDisplays as what is set as the Waitlist Appointment Landing Page Screen Text under Waitlist Settings.
waitListFirstAvailablebooleanIndicates whether or not the Show Reason Super Groups in Flow Allow Waitlist First Available box is checked under Service & Class Panel Waitlist Settings.
showStaffGroupbooleanNot set up yet
smsHintwaitListFirstAvailableTextstringDisplays as what is set as the Waitlist First Available Text Message Hint Description under Client Info Waitlist Settings.
staffGroupTextwaitListSuccessTextstringNot set up yet
staffGroupTitlestringNot set up yet
staffNoPreferenceintegerIndicates whether it is set to Show or Hide 'No Preference' Option under Staff Panel Settings.
staffTextDisplays as what is set as the Waitlist Confirmation Message under Waitlist Settings.
waitListTextstringDisplays as what is set as the Header Join Waitlist Link Text under Staff Panel Waitlist Settings.
staffTitlewelcomeTextstringDisplays as what is set as the Panel Title under Staff Panel SettingsWelcome Message under Mini Website Design.
thanksCourseswelcomeTitlestringDisplays as what is set as the Appointment Saved Message (for courses) under Confirmation Panel Settings.
thanksInfostringDisplays as what is set as the Appointment Saved Message under Confirmation Panel Settings.
thanksInfoConfirmstringDisplays as what is set as the Appointment Awaiting Staff Confirmation Message Message under Confirmation Panel Settings.
thanksInfoPaymentstringDisplays as what is set as the Confirmation Message under Payment Settings.
thanksPaymentTitlestringDisplays as what is set as the Confirmation Title under Payment Settings.
thanksTitlestringDisplays as what is set as the Confirmation Panel Title under Confirmation Pane Settingsl.
thanksWaitListTitlestringDisplays as what is set as the Waitlist Confirmation Panel Title under Waitlist Settings.
timeFormat24HrsbooleanIndicates whether or not specified the 24 Hour Format box is checked under Time Panel Settings.
timeTextstringDisplays as what is set as the Header Text under Time Panel Settings.
timeTitlestringDisplays as what is set as the Panel Title under Time Panel Settings.
timezoneobjectDisplays the timezone object for timezone of business - for more info, see Timezones API page.
upcomingApptBtnLabelstringDisplays as the label that is set to appear on the Open Appointments Button under Mini Website Design.
viewApptLabelstringDisplays as what is set as the View Appointments Button Label under Mini Website Design.
viewInvoiceLabelstringDisplays as what is set as the View Invoices Button Label under Mini Website Design.
waitListAcceptScreenHeaderstringDisplays as what is set as the Waitlist Appointment Landing Page Header under Waitlist Settings.
waitListAcceptScreenTextstringDisplays as what is set as the Waitlist Appointment Landing Page Screen Text under Waitlist Settings.
waitListFirstAvailablebooleanIndicates whether or not specified scheduler preference is set to Allow Waitlist First Available.
waitListFirstAvailableTextstringDisplays as what is set as the Waitlist First Available Text Description under Waitlist Settings.
waitListSuccessTextstringDisplays as what is set as the Waitlist Confirmation Message under Waitlist Settings.
waitListTextstringDisplays as what is set as the Join Waitlist Link Text under Waitlist Settings.
welcomeTextstringDisplays as what is set as the Welcome Message under Mini Website Design.
welcomeTitlestringDisplays as what is set as the Welcome Panel Title under Mini Website Design.Welcome Panel Title under Mini Website Design.

appMode key

appMode #Description
1Location > Staff > Services & Classes
2Location > Services & Classes > Staff
3Staff > Location > Services & Classes
4Staff > Services & Classes > Location
5Services & Classes > Staff > Location
6Services & Classes > Location > Staff
8Location > Services & Classes
10Staff > Services & Classes
11Services & Classes > Staff
12Services & Classes > Location
15Services & Classes
17

Location Group > Location > Staff > Services & Classes 

18Location Group > Staff > Services & Classes
19Location Group > Location > Services & Classes > Staff
20Location Group > Services & Classes > Staff
21Staff > Location Group > Location > Services & Classes
22Staff > Location Group > Services & Classes
23Staff > Services & Classes > Location Group > Location
24Staff > Services & Classes > Location Group
25Services & Classes > Staff > Location Group > Location
26Services & Classes > Staff > Location Group
27Services & Classes > Location Group > Location > Staff
28Services & Classes > Location Group > Staff
29Location Group > Location > Services & Classes
30Location Group > Services & Classes
31

Services & Classes > Location Group > Location

32Services & Classes > Location Group
33Staff > Services & Classes > Location Super Group > Location Group > Location
34Staff > Services & Classes > Location Super Group > Location Group
35Services & Classes > Staff > Location Super Group > Location Group > Location
36Services & Classes > Staff > Location Super Group > Location Group
37Services & Classes > Location Super Group > Location Group > Location > Staff
38Services & Classes > Location Super Group > Location Group > Staff
39Location Super Group > Location Group > Location > Services & Classes
40Location Super Group > Location Group > Services & Classes
41Services & Classes > Location Super Group > Location Group > Location
42Services & Classes > Location Super Group > Location Group