Home > Agendize Scheduling

Settings


Resource representation

{ "notifications": { "managerEmailWidgetNew": {boolean}, "managerSMSWidgetNew": {boolean}, "managerEmailWidgetCancel": {boolean}, "managerSMSWidgetCancel": {boolean}, "managerEmailWidgetChange": {boolean}, "managerSMSWidgetChange": {boolean}, "managerEmailDecline": {boolean}, "managerSMSDecline": {boolean}, "managerEmailDashboardCancel": {boolean}, "managerSMSDashboardCancel": {boolean}, "managerEmailDashboardChange": {boolean}, "managerSMSDashboardChange": {boolean}, "staffEmailWidgetNew": {boolean}, "staffSMSWidgetNew": {boolean}, "staffEmailWidgetCancel": {boolean}, "staffSMSWidgetCancel": {boolean}, "staffEmailWidgetChange": {boolean}, "staffSMSWidgetChange": {boolean}, "staffEmailDashboardCancel": {boolean}, "staffSMSDashboardCancel": {boolean}, "taffEmailDashboardChange": {boolean}, "staffSMSDashboardChange": {boolean}, "clientEmailWidgetNew": {boolean}, "clientSMSWidgetNew": {boolean}, "clientEmailWidgetPendingNew": {boolean}, "clientSMSWidgetPendingNew": {boolean}, "clientEmailDashboardNew": {boolean}, "clientSMSDashboardNew": {boolean}, "clientEmailWidgetCancel": {boolean}, "clientSMSWidgetCancel": {boolean}, "clientEmailWidgetChange": {boolean}, "clientSMSWidgetChange": {boolean}, "clientEmailDashboardCancel": {boolean}, "clientSMSDashboardCancel": {boolean}, "clientEmailAccept": {boolean}, "clientSMSAccept": {boolean}, "clientEmailDecline": {boolean}, "clientSMSDecline": {boolean}, "clientEmailNoShow": {boolean}, "clientEmailComplete": {boolean}, "clientEmailMandatoryPaymentPending": {boolean}, "clientSMSMandatoryPaymentPending": {boolean}, "clientEmailDashboardChange": {boolean}, "clientSMSDashboardChange": {boolean}, "clientEmailFeedback": {boolean} }, "items": { "scheduledItems": {string} "quickStartServiceChoice": {boolean}, "resourceNumberChoice": {boolean}, "resourceIterationChoice": {boolean} } "contact": { "managerEmailAddress": {string}, "managerMobilePhoneNumber": {string) } "reminders': { "firstReminder": {string}, "secondReminder": {string}, "emailReminders": {boolean} "smsReminders": {boolean} "staffReminders": {boolean} }, "rules": { "validation": {string}, "authorizedClients": {string}, "maxAppointmentDate": {string}, "minAppointmentDate": {string}, "dailyClientAppointmentMax": {integer}, "waitingList": {boolean} }, "widget": { "freeSlotsIntervalTime": {string}, "headerBackgroundColor": {string}, "dateFormat": {string}, "displayDuration": {boolean}, "customCSS": {string}, "customJavascript": {string} } }
Parameter name Value Description
notifications object Account manager, staff and client notifications. writable
notifications.managerEmailWidgetNew boolean Email notification to account manager when a client books a new appointment. writable
notifications.managerEmailWidgetNew boolean Email notification to account manager when a client books a new appointment. writable
notifications.managerSMSWidgetNew boolean SMS notification to account manager when a client books a new appointment. writable
notifications.managerEmailWidgetCancel boolean Email notification to account manager when a client cancels an appointment. writable
notifications.managerSMSWidgetCancel boolean SMS notification to account manager when a client cancels an appointment. writable
notifications.managerEmailWidgetChange boolean Email notification to account manager when a client reschedules an appointment. writable
notifications.managerSMSWidgetChange boolean SMS notification to account manager when a client reschedules an appointment. writable
notifications.managerEmailDecline boolean Email notification to account manager when an appointment is declined by a staff. writable
notifications.managerSMSDecline boolean SMS notification to account manager when an appointment is declined by a staff. writable
notifications.managerEmailDashboardCancel boolean Email notification to account manager when an appointment s cancelled in the dashboard. writable
notifications.managerSMSDashboardCancel boolean SMS notification to account manager when an appointment is cancelled in the dashboard. writable
notifications.managerEmailDashboardChange boolean Email notification to account manager when an appointment is rescheduled in the dashboard. writable
notifications.managerSMSDashboardChange boolean SMS notification to account manager when an appointment is rescheduled in the dashboard. writable
notifications.staffEmailWidgetNew boolean Email notification to staff member when a client books a new appointment. writable
notifications.staffSMSWidgetNew boolean SMS notification to staff member when a client books a new appointment. writable
notifications.staffEmailWidgetCancel boolean Email notification to staff member when a client cancels an appointment. writable
notifications.staffSMSWidgetCancel boolean SMS notification to staff member when a client cancels an appointment. writable
notifications.staffEmailWidgetChange boolean Email notification to staff member when a client reschedules an appointment. writable
notifications.staffSMSWidgetChange boolean SMS notification to staff member when a client reschedules an appointment. writable
notifications.staffEmailDashboardCancel boolean Email notification to staff member when an appointment is cancelled in the dashboard. writable
notifications.staffSMSDashboardCancel boolean SMS notification to staff member when an appointment is cancelled in the dashboard. writable
notifications.staffEmailDashboardChange boolean Email notification to staff member when an appointment is rescheduled in the dashboard. writable
notifications.staffSMSDashboardChange boolean SMS notification to staff member when an appointment is rescheduled in the dashboard. writable
notifications.clientEmailWidgetNew boolean Email notification to client when this client books a new appointment. writable
notifications.clientSMSWidgetNew boolean SMS notification to client when this client books a new appointment. writable
notifications.clientEmailWidgetPendingNew boolean Email notification to client when this client requests an appointment (manual acceptation mode). writable
notifications.clientSMSWidgetPendingNew boolean SMS notification to client when this client requests an appointment (manual acceptation mode). writable
notifications.clientEmailDashboardNew boolean Email notification to client when a new appointment is booked in the backoffice. writable
notifications.clientSMSDashboardNew boolean SMS notification to client when a new appointment is booked in the backoffice. writable
notifications.clientEmailWidgetCancel boolean Email notification to client when this client cancels an appointment. writable
notifications.clientSMSWidgetCancel boolean SMS notification to client when this client cancels an appointment. writable
notifications.clientEmailWidgetChange boolean Email notification to client when this client reschedules an appointment. writable
notifications.clientSMSWidgetChange boolean SMS notification to client when this client reschedules an appointment. writable
notifications.clientEmailDashboardCancel boolean Email notification to client when an appointment is cancelled in the dashboard. writable
notifications.clientSMSDashboardCancel boolean SMS notification to client when an appointment is cancelled in the dashboard. writable
notifications.clientEmailAccept boolean Email notification to client when a new appointment is accepted (manual acceptation mode). writable
notifications.clientSMSAccept boolean SMS notification to client when a new appointment is accepted (manual acceptation mode). writable
notifications.clientEmailDecline boolean Email notification to client when a new appointment is declined (manual acceptation mode). writable
notifications.clientSMSDecline boolean SMS notification to client when a new appointment is declined (manual acceptation mode). writable
notifications.clientEmailNoShow boolean Email notification to client when an appointment is marked as no show. writable
notifications.clientEmailComplete boolean Email notification to client when an appointment is marked as completed. writable
notifications.clientEmailMandatoryPaymentPending boolean Email notification to client when an appointment need to be confirmed with mandatory payment. writable
notifications.clientSMSMandatoryPaymentPending boolean SMS notification to client when an appointment need to be confirmed with mandatory payment. writable
notifications.clientEmailDashboardChange boolean Email notification to client when an appointment is rescheduled in the dashboard. writable
notifications.clientSMSDashboardChange boolean SMS notification to client when an appointment is rescheduled in the dashboard. writable
notifications.clientEmailFeedback boolean Enable or disable feedback email sent at the end of the appointment. writable
items object Items used in widget selection mode writable
items.scheduledItems boolean Scheduled items. "service", "service-staff", "staff-service", "resource", "quickStart". writable.
items.quickStartServiceChoice boolean For quick start mode, allow client to select a service. writable
items.resourceNumberChoice boolean Allow customer to specify the number of resources. writable
items.resourceIterationChoice boolean Allow customer to book multiple iterations. writable
contact object Manager contact informations. writable
contact.managerEmailAddress string Manager email address for email notifications. writable
contact.managerMobilePhoneNumber string Manager mobile phone number for SMS notifications. writable
reminders object Reminders settings. writable
reminders.firstReminder string Delay for first reminder, in minute . "never" (default), "5" "10", "15", "60", "120", "360", "720", "1440", "2280", "4320", "dayMorning", "dayBeforeEvening". writable.
reminders.secondReminder string Delay for second reminder, in minute . "never" (default), "5" "10", "15", "60", "120", "360", "720", "1440", "2280", "4320", "dayMorning", "dayBeforeEvening". writable.
reminders.emailReminders boolan Activate reminder by email. writable
reminders.smsReminders boolean Activate reminder by SMS. writable
reminders.staffReminders boolean Activate staff reminders. writable
rules object Appointment rules. writable
rules.validation string New appointments need to be reviewed and accepted. "auto", "manager", "staff". writable
rules.authorizedClients string Type of user can schedule an appointment online "all", "clients", "none". writable
rules.maxAppointmentDate string Maximal date in the futur user can schedule an appointment online "weeks-1", "weeks-2", "weeks-3", "months-1", "months-2", "months-3", "months-6", "years-1". writable
rules.minAppointmentDate string Minimal date in the futur user can schedule an appointment online "hours-1", "minutes-90", "hours-2", "hours-4", "hours-8", "hours-12", "days-1", "days-2", "weeks-1", "weeks-1", "weeks-2", "weeks-3", "months-1". writable
rules.dailyClientAppointmentMax integer Maximum number of appointments per client per day 0 (no limit), 1, 2, 3, 4, 5. writable
rules.>waitingList boolean Activate the waiting list. writable
widget object Widget options.. writable
widget.freeSlotsIntervalTime string Free slots interval time "service": service duration (for service mode)
"resource" : resource duration (for resource mode)
"service+buffer": service duration + buffer time (Do not use in resource mode)
"15": 15 minutes
"30": 30 minutes
"45": 45 minutes
"60": 60 minutes
"120": 120 minutes
writable
widget.headerBackgroundColor string Background color of the widget header Hexadecimal web color. Default Color: #313131. writable.
widget.dateFormat string Date format used for display dates and durations Standardized date formats. writable.
widget.displayDuration boolean Display service or resource durations in widget pages. writable
widget.customCSS string Custom CSS to personalize widget design. writable
widget.customJavascript string Custom Javascript to personalize widget design and interactions. writable

List

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET http://beta.agendize.com/api/2.1/scheduling/companies/{companyId}/settings

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
Optional query parameters
group string Settings group identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{ items: [Settings resource] }

Update

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

PUT http://beta.agendize.com/api/2.1/scheduling/companies/{companyId}/settings

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.

Request body

In the request body, supply a list of Setting resource with the following properties:

Parameter name Value Description
Required Properties
group string The group of settings.
id string The id of the company setting.
value string The value of the company setting.

Request body structure:

{ items: [Setting resource] }

Response

If successful, this method returns all company's Setting resources in the response body.