OnSched Setup API

Create Linked Services Use this endpoint to explicitly Link Services to a Resource. A valid resource id is required. Note: By default, the services array is empty which signifies that all services are provided by the resource. Linking services here will add to the linked service(s) array available to this resource. This will limit the services available to the resource. You cannot post services that already exist in the array, you can only add new ones. Use the PUT ​/setup​/v1​/resources​/{id}​/services endpoint to update the entire list.

Upload Resource Image Use this endpoint to Upload a resource image to the resource. A valid resource id is required. You must convert the image to a base64 encoded string and pass that string as input along with your filename.

Create Service Group Use this endpoint to Create a Service Group. If no locationId is specified in the body, the business location will default to the primary business location. Service groups are used to categorize services. Service groups are optional and only make sense if you have multiple services that will be easier read if categorized. Only the service group Type of 0 is supported by the API. It defaults to 0 if not supplied.

Create Service Use this endpoint to Create a new service. If not specified, the business location defaults to the primary business location. Note: Posting a service to the Primary Business Location will scope as company scoped and make the service available to all locations. If you want a service to only be available from a specific location, include the business location id. Required fields: Name and Duration The service Type is either, 1 = Appointment or 2 = Event. Default is 1 if not specified. For type = 1, Appointments - Create an availability entry for each weekday to provide the service for. All days of the week must be provided when adding service availability. Days are defined as sun, mon, tue, wed, thu, fri and sat. Start and End Times are entered in military format. e.g., 800 is 8:00am, 2230 is 10:30pm. If not provided, it defaults to the primary location business hours. We support 24-hour availability, set startTime=0 and endTime=2400. To set a whole day as unavailable, set both the startTime and endTime to 0. If you require times in between specified hours to be unavailable, use the service block endpoint at: POST ​/setup​/v1​/services​/{id}​/block. For type = 2, Events - Create service allocations for their availability. Refer to the: POST /setup​/v1​/services​/{id}​/allocations to set up service allocations for the event. Options are available for customer selected durations, for details: Variable Duration Overview Additional parameters include but are not limited to bookingLimit, maxCapacity and maxGroupSize. For details: Service Limits Overview

Link Service to Calendar Use this endpoint to Link a Service to a calendar.

Create Allocation Use this endpoint to Create a service allocation for a service. A valid service id is required. Service allocations are used for Event type services only. Service allocations allow you to specify the time(s) a service is available as opposed to using weekly availability which represents a weekly schedule, ie: Mon-Fri 9am-5pm. Required fields: startDate, endDate, startTime, endTime and reason. Service allocations can be set to specific time ranges or for the whole day by setting startTime=0 and endTime=2400. Service allocations can repeat for a specific date range instance or set to repeat at a specified frequency. Repeat object: (repeats = true) The frequency can be set to a value of D, W or M for Day, Week or Month respectively. Use the interval property to specify the interval that the allocation repeats. For example, an interval of 2 for a weekly allocation means that the allocation will repeat every 2nd week beginning at the day specified. A daily allocation with an interval of 10 means the allocation will repeat every 10 days. The interval property applies to all repeat frequencies. If using the repeat functionality an interval value is required. DAILY ALLOCATIONS: Will repeat for each day of the week for the date range specified for the interval specified. An interval value of “1” repeats every day, and an interval value of “3” is every 3rd day. WEEKLY ALLOCATIONS: Will repeat only on the specified days of the week for the date range specified. For weekly the frequency is required and should be set to “W”. You must specify the “weekdays” parameter. Weekdays are expressed as a string of digits with each single digit in the string representing a day of the week. The possible values are 0,1,2,3,4,5,6 where 0=Sunday, 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday. For example, a weekly frequency with an interval of “1”, and an entry of weekdays = “24”, will repeat each week on Tuesday and Thursday for the duration of the allocation date range. MONTHLY ALLOCATIONS: Will repeat either on the day of the month specified in the monthDay property or on the day of the week and week of the month specified by the monthType property. In both cases frequency is required and should be set to “M”, monthly. monthDay is the day of the month you want allocated. If monthDay=’15’ this means to allocate the 15th of every month in the date range requested. Using monthDay in conjunction with monthType addresses “day of the week and week of the month” scenario. There are two possible values for monthType: D for Day of Month or W for Week of Month. For monthType D, monthDay value must be between 1 and 31. It is the day of the month to repeat on. For monthType M, monthDay value contains 2 digits: day of week (0-6), (0,1,2,3,4,5,6 where 0=Sunday, 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday) and week of month (1-5). 1 being the first week, 2 being the second. The third Thursday of the month is depicted as a monthType=”M” and monthDay=”43”. Repeats will end on the date specified by the end date.

Create Allocations Bulk Use this endpoint to Create bulk service allocations. A valid service id is required. Use this endpoint only if you need to POST multiple service allocations in one transaction. For details refer to: Post Service Allocation

Create Block Use this endpoint to Create a Service Block. A valid service id is required. Required fields: startDate, endDate, startTime, endTime and reason. Service blocks can be set to specific time ranges or for the whole day. To block a whole day set startTime to 0 and endTime to 2400. Service blocks can be for a specific date range instance or set to repeat at a specified frequency. Repeat object: (repeats = true) The frequency can be set to a value of D, W or M for Day, Week or Month respectively. Use the interval property to specify the interval that the block repeats. For example, an interval of 2 for a weekly block means that the block will repeat every 2nd week beginning at the day specified. A daily block with an interval of 10 means the block will repeat every 10 days. The interval property applies to all repeat frequencies. If using the repeat functionality an interval value is required. DAILY BLOCKS: Will repeat for each day of the week for the date range specified for the interval specified. An interval value of “1” repeats every day, and an interval value of “3” is every 3rd day. WEEKLY BLOCKS: Will repeat only on the specified days of the week for the date range specified. For weekly the frequency is required and should be set to “W”. You must specify the weekdays parameter. Weekdays are expressed as a string of digits with each single digit in the string representing a day of the week. The possible values are 0,1,2,3,4,5,6 where 0=Sunday, 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday. For example, a weekly frequency with an interval of “1”, and an entry of weekdays = “24”, will repeat each week on Tuesday and Thursday for the duration of the block date range. MONTHLY BLOCKS: Will repeat either on the day of the month specified in the monthDay property or on the day of the week and week of the month specified by the monthType property. In both cases frequency is required and should be set to “M”, monthly, monthDay is the day of the month you want blocked. If monthDay=’15’ this means to block the 15th of every month in the date range requested. Using monthDay in conjunction with monthType addresses “day of the week and week of the month” scenario. There are two possible values for monthType: D for Day of Month or W for Week of Month. For monthType D, monthDay value must be between 1 and 31. It is the day of the month to repeat on. For monthType M, monthDay value contains 2 digits: day of week (0-6), (0,1,2,3,4,5,6 where 0=Sunday, 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday) and week of month (1-5). 1 being the first week, 2 being the second. The third Thursday of the month is depicted as a monthType=”M” and monthDay=”43”. Repeats will end on the date specified by the end date.

Upload Service Image Use this endpoint to Upload an image to the service. A valid service id is required. You must convert the image to a base64 encoded string and pass that string as input along with your filename.

Reassign Appointment Use this endpoint to Reassign an appointment from one resource to another. The result returned is a single appointment that was reassigned to the target resource. A valid appointment id and resource id is required. Find appointment id's by using the GET /setup/v1/appointments endpoint, find resource id's by using the GET ​/setup​/v1​/resources endpoint.

Update User Use this endpoint to Update a Business User. A valid businessUser id is required. Business Roles Include: bizowner (Business Owner), bizadmin (Business Administrator), bizresource (Business User - Bookable Resource).

Update Calendar Block Use this endpoint to Create a Calendar Block. A valid calendarBlock id is required. Refer to the POST ​/setup​/v1​/calendars​/{id}​/block endpoint for fieldnames and details.

Update Calendar Use this endpoint to Update a calendar object. A valid calendar id is required. When your company was created a calendar object was automatically created with 24-hour weekly availability. Its name = Main, the type = resource and by default the interval = 30 mins. We are currently supporting resource calendar type. Other types were part of our Legacy Application and has no relevance in the API product.

Recover Calendar Use this endpoint to Recover a previously deleted calendar object. A valid calendar id is required.

Update Company Use this endpoint to Update the authorized company information. Your client credentials resolve to a single company. The timezoneName must be expressed as an IANA Timezone, e.g., America/New_York. For more information: Timezone IANA Wiki

Update Company Domain Use this endpoint to Update an OnSchedJs domain for your authorized company. A valid companyDomain id is required.

Update Region Use this endpoint to Update a region object. A valid region id is required.

Update Location Use this endpoint to Update a business location object. A valid business location id is required. The optional removeRegion query parameter can be used to remove the region relationship from the location. If the settings element is populated the scope will be set to the business location with the settings supplied. If your settings are uniform across all locations, then do not supply the settings element and the location will use the settings defined on the primary business location (company scoped). Company scoped settings cascade down to the locations. You can override any location that needs different settings by providing settings in the update model. Use the PUT /setup/v1/locations/{id}/settings/scope/{settingsScope} endpoint to change the settings scope only. This is typically used when switching from business location scope back to company. Refer to: POST ​/setup​/v1​/locations endpoint for details.

Update Reminders Use this endpoint to Update Email and SMS appointment reminder settings for the requested location. A valid business location id is required. Appointment Reminders Reminder values are used to define how many hours, days, or weeks (interval value) prior to the appointment to send the reminder. Interval values are used to define the reminder interval: 1 = Hours, 2 = Days and 3 = Weeks. The reminder fields are numbers. If you are using the hours interval, use a number from 1 to 24. Example 1: emailFirstReminder: 1, emailFirstReminderInterval: 2 - results in 1st reminder being sent 1 Day before the appointment time. Example 2: emailSecondReminder: 3, emailSecondReminderInterval: 1 - results in 2nd reminder being sent 3 Hours before the appointment time.

Update Location Holidays Use this endpoint to Update Business Holidays as Opened or Closed. A valid business location id is required. If not specified, the business location defaults to the primary business location. Holidays are automatically defined with the initial Post Location endpoint and are based on country code. Find your location holiday codes by using the: GET /setup​/v1​/locations​/{id} endpoint. Change your holidays to open or closed by passing in the holidayId along with the closed boolean value to change the status of a specific holiday. Pass in an asterisk * for the holidayId then all business holidays will be set as defined.

Recover Location Use this endpoint to Recover a deleted business location. A valid business location id is required.

Update Location Scope Use this endpoint to Update a business locations online booking settings scope. A valid business location id is required. settingsScope values are 0 = company scope, 1 = business location scope. To inherit the online settings defined in the primary business location, then use value = 0 for company scope. Otherwise, to override the settings for a specific location then use value = 1 for business location scope. Note: You cannot change the settings scope of the Primary Business Location.

Update Resource Group Use this endpoint to Update a resourceGroup object. A valid resourceGroup id is required.

Recover Resource Group Use this endpoint to Recover a deleted resourceGroup object. A valid resourceGroup id is required.

Update Allocation Use this endpoint to Update a resource allocation. A valid resourceAllocation id is required. Refer to the POST /setup/v1/resources/{id}/allocations endpoint for details.

Update Block Use this endpoint to Update a Resource Block. A valid resourceBlock id is required. Refer to the POST ​/setup​/v1​/resources​/{id}​/block endpoint for fieldnames and details.

Update Resources Bulk Use this endpoint to Bulk Update resources. Valid resource id's are required. The list of resources cannot exceed 100 resource objects per transaction for performance purposes. Required Fields: Email Address and Name Providing a single or many serviceId(s) in the service array will result the resource explicitly being available to provide those services only. While passing in an empty array will result in all services being available to the resources. This includes all company and business scoped services. See the POST ​/setup​/v1​/resources​/{id}​/services endpoint for details about explicitly linking services. Set the resource availability type by using the recurringAvailability flag. Set recurringAvailability to True for Weekly Availability or False for Resource Allocations.

Update Resource Use this endpoint to Update a resource. A valid resource id is required. Required Fields: Email Address and Name Providing a single or many serviceId(s) in the service array will result the resource explicitly being available to provide those services only. While passing in an empty array will result in all services being available to the resources. This includes all company and business scoped services. See the POST ​/setup​/v1​/resources​/{id}​/services endpoint for details about explicitly linking services. Set the resource availability type by using the recurringAvailability flag. Set recurringAvailability to True for Weekly Availability or False for Resource Allocations.

Update Weekly Availability Use this endpoint to Update resource weekly availability. A valid resource id is required. The availability day entries are created when a resource object is created. To update weekly availability hours, all days of the week must be provided. Days are defined as sun, mon, tue, wed, thu, fri and sat. The startTime and endTime fields are entered in military format. e.g., 800 is 8:00am, 2230 is 10:30pm. We support 24-hour availability, set startTime=0 and endTime=2400. To set a whole day as unavailable, set both the startTime and endTime to 0. If you require times in between specified hours to be unavailable, use the resource blocks endpoints. Times entered represent the timezone of the resource. Resources can be set to any world timezone.

Reassign Resource Use this endpoint to Reassign appointments from one resource to another. If the startDate is not supplied, the default is today's date + 1 day; If the endDate is not supplied, all future appointments from the start date will be reassigned. If the calendar id is not supplied the default is the primary calendar of the location.

Recover Resource Use this endpoint to Recover a deleted resource. A valid resource id is required.

Update Linked Services Use this endpoint to Update the linked services of a Resource. A valid resource id is required. Updating services with this endpoint will update the linked services available to the resource. Only those services will be available to the resource. Note: This is a destructive process, any existing linked services will be removed and replaced with the list of services supplied here. Provide the resources complete list of services when using this endpoint.

Update Service Group Use this endpoint to Update a Service Group object. A valid serviceGroup id is required.

Recover Service Group Use this endpoint to Recover a deleted Service Group. A valid serviceGroup id is required.

Update Allocation Use this endpoint to Update a service allocation. A valid serviceAllocation id is required. Refer to the POST /setup/v1/services/{id}/allocations endpoint for fields names and details.

Update Block Use this endpoint to Update a Service Block. A valid serviceBlock id is required.

Update Service Use this endpoint to Update a service object. A valid service id is required.

Update Weekly Availability Use this endpoint to Update service weekly availability. A valid service id is required. The availability day entries are created when a service object is created. To update weekly availability hours, all days of the week must be provided. Days are defined as sun, mon, tue, wed, thu, fri and sat. The startTime and endTime fields are entered in military format. e.g., 800 is 8:00am, 2230 is 10:30pm. We support 24-hour availability, set startTime=0 and endTime=2400. To set a whole day as unavailable, set both the startTime and endTime to 0. If you require times in between specified hours to be unavailable, use the resource blocks endpoints. Times entered represent the timezone of the business location.

Recover Service Use this endpoint to Recover a deleted service object. A valid service id is required.