Skip to main content

Weekly Availability

The Weekly Availability API provides endpoints for managing recurring availability patterns for calendars and services. These endpoints allow you to create, retrieve, update, and delete weekly schedules, as well as manage their associated working hours and exceptions.

Overview​

Weekly schedules allow you to:

  • Define regular working hours for each day of the week
  • Set special schedules for specific dates
  • Manage out-of-office periods
  • Associate schedules with services and calendars
  • Handle different time zones

Authentication​

All Weekly Availability API endpoints require authentication using the ONLIVESITE authentication scheme. Include the following header in all requests:

Authorization: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature

Available Endpoints​

Schedule Management​

  • Create Schedule - Create a new weekly availability schedule
  • Get Schedule - Retrieve details of a specific schedule
  • List Schedules - Get a filtered list of schedules
  • Update Schedule - Modify an existing schedule's configuration
  • Delete Schedule - Remove a schedule from the system

Schedule Association​

  • Associate schedules with services
  • Link schedules to calendars
  • Manage timezone settings

Common Use Cases​

  • 📅 Setting up regular business hours
  • 🕒 Managing split shifts and breaks
  • 📆 Handling holiday schedules
  • 🌍 Configuring timezone-specific availability
  • 🏢 Managing multiple location schedules
  • 🔄 Creating recurring availability patterns

For detailed information about specific operations, please refer to the individual endpoint documentation sections.