Create Scheduler

Add a new Scheduler to an account.

Notes

label

Name/Label for the scheduler.

timezone

A valid timezone string. Default timezone is EST5EDT.

business_hours

An object with business hours options.

  • business_hours_service_type - Routes call to a particular service type during business hours. Valid service types are Phonenumber, SpeedDial, Scheduler, Conference, Device, Scheduler, IVRMenu, TimeOfDayRoute, VoiceMail, Hangup, Busy, Reject, WebHook or WebRequest.
  • business_hours_service_id - Service type id for the business hours service type
  • after_hours_service_type - Routes call to a particular service type during after hours. Valid service types are Phonenumber, SpeedDial, Scheduler, Conference, Device, Scheduler, IVRMenu, TimeOfDayRoute, VoiceMail, Hangup, Busy, Reject, WebHook or WebRequest.
  • after_hours_service_id - Service type id for the after hours service type
  • lunch_hours_service_type - Routes call to a particular service type during lunch hours. Valid service types are Phonenumber, SpeedDial, Scheduler, Conference, Device, Scheduler, IVRMenu, TimeOfDayRoute, VoiceMail, Hangup, Busy, Reject, WebHook or WebRequest.
  • lunch_hours_service_id - Service type id for the lunch hours service type
  • monday, tuesday, wednesday, thursday, friday, saturday, sunday - For weekdays it requires business open and close time. Lunch start and end times are optional.

holiday_hours

  • holiday_hours_service_type - Routes call to a particular service type during holiday hours. Valid service types are Phonenumber, SpeedDial, Scheduler, Conference, Device, Scheduler, IVRMenu, TimeOfDayRoute, VoiceMail, Hangup, Busy, Reject, WebHook or WebRequest.
  • holiday_hours_service_id - Service type id for the holiday hours service type
  • holidays - Array of the holiday object.
    • holiday_name - Name/Label for the holiday.
    • holiday_type - A public holiday or a custom holiday. Custom holiday will require start and end time.
    • custom_holiday_start - Custom holiday start time in MM-DD HH:mm format.
    • custom_holiday_end - Custom holiday end time in MM-DD HH:mm format.

override_mode

Override mode option can be used to override all other settings. Available modes are Scheduler, OfficeHours, AfterHours, Lunch and Holiday.

override_extension

1 to 6 digit extension to change override mode.

Response Properties
PropertyTypeDescription
schedulerobjectScheduler
Language
Authorization
Header
Click Try It! to start a request and see the response here!