Scheduler Link
These are the endpoints that are available under the /schedulerLink path, which lists all the custom booking sites you have created on your business' account.
Endpoint | Description |
|---|---|
| GET /schedulerLink | Returns all schedulerLink objects on your business' account in array format. |
| GET /schedulerLink/{schedulerLinkId} | Returns a JSON object for the specified scheduler link. |
| GET /schedulerLink/{objectType}/{objectId} | Returns a JSON object for the scheduler link that corresponds to the specified objectType and objectId. Can have objectType values "STAFF", "LOCATION", "REASON", and "GROUP". |
| POST /schedulerLink | Creates a new schedulerLink object on your business' account. Request body/payload: Must pass a schedulerLink object in the request body/payload. For these calls, you need to pass a schedulerLink object with all required fields and any fields you want to set filled in the body of the payload - must include the schedulerType property that corresponds to where you created the specified scheduler link. We have an example of a schedulerLink object in the responses section below and have indicated the required fields in the object values table at the bottom of this page. |
| PUT /schedulerLink | Updates an existing schedulerLink object on your business' account. Request body/payload: Must pass a schedulerLink object in the request body/payload. For these calls, you need to pass a schedulerLink object with all required fields and any fields you want to update filled in the body of the payload - must include businessId and schedulerLinkId. We have an example of a schedulerLink object in the responses section below and have indicated the required fields in the object values table at the bottom of this page. |
| DELETE /schedulerLink/{schedulerLinkId} | Removes a schedulerLink object from view by setting its active property to false. |
There are no parameters associated with schedulerLink calls.
The objects below represent the minimum viable objects to pass that are needed to create or update a schedulerLink object. Check whether or not a property can be written to by looking at the Object Values table below to see if the property is writable.
| Property name | Type | Required | Description |
|---|---|---|---|
| active | boolean | Yes | Indicates whether or not the specified scheduler link is active. |
| appMode | integer | Yes | Displays as the appMode of the specified scheduler link - for more info on appMode and a table describing the different values, see the Scheduler Preference API page. If this property is left null, that means that the schedulerLink will pick up the values from the default scheduler on the account. |
| booleanJson | array | Provides an array of various booleans to check any values set there to see if they override any values set on the pref_scheduler object. | |
| booleanMap | array | Provides an array of boolean properties for the specified scheduler link. | |
| businessId | integer | Yes | Provides unique numeric ID for the business the specified scheduler link belongs to. |
| classScheduleIdList | array | Displays as a list of the IDs of any class schedules connected to the specified scheduler link. | |
| clientSSO | boolean | Indicates whether or not the specified scheduler link allows for client Single Sign On. | |
| continueShoppingUrl | string | Displays what is set as the Button Redirect URL for the specified scheduler link. | |
| createdDate | integer | Displays as date the specified scheduler link was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. | |
| createdUser | string | Displays the username of user who created the specified scheduler link. | |
| defaultOnlyBusinessConfigProps | array | Provides an array of settings set on the business_config table that apply to the default scheduler link. | |
| defaultOnlyBusinessProps | array | Provides an array of settings set on the business table that apply to the default scheduler link. | |
| defaultOnlySchedPreferenceProps | array | Provides an array of settings set on the pref_scheduler table that apply to the default scheduler link. | |
| domain | string | Yes | Displays as the domain of the specified scheduler link. For the purposes of TimeTap, this will be set to "timetap.com". |
| googleAnalyticsCode | string | Displays as the Google Analytics code for the specified scheduler link. | |
| googleTagManagerCode | string | Displays as the Google Tag Manager code for the specified scheduler link. | |
| groupIdList | array | Displays as a list of the IDs of any groups connected to the specified scheduler link. | |
| handle | string | Yes | Displays as the what is set as the webhandle of the specified scheduler link. If nothing is set here, TimeTap will generate a unique alphanumeric string to fill it. |
| hideFromBots | boolean | Indicates whether or not the specified scheduler will be hidden from bots. | |
| internalName | string | Displays as what is set as the Internal Name of the specified scheduler link upon its creation. | |
| labelJson | string | Displays as a string representation of the JSON object describing the the labels used for the specified scheduler link. | |
| labelMap | object | Should mimic the properties and values stored on labelJson, just using object representation instead of a string. | |
| landingPageStylesJson | array | Displays all changes that have been made to the default booking site's styles on the specified scheduler link. | |
| locationGroupList | string | Displays as a list of the names of any location groups that are set to show on the specified scheduler link. | |
| locationIdList | array | Displays as a list of the IDs of any locations that are set to show on the specified scheduler link. | |
| locationList | string | Displays as a list of the names of any locations that are set to show on the specified scheduler link. | |
| locationSuperGroupList | sting | Displays as a list of the names of any location super groups that are set to show on the specified scheduler link. | |
| logoUrl | string | if this property is left null, that means that the schedulerLink will pick up the values from the default scheduler on the account. | |
| miniWebRedirect | string | ||
| modifiedDate | integer | Displays as date the specified scheduler link was last modified in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. | |
| modifiedUser | string | Displays the username of user who last modified the specified scheduler link. | |
| numberJson | string | Displays as a property on the scheduler_link table where you can set overrides for several of the number based properties on the pref_scheduler table. | |
| numberMap | string | Displays as a readable object that is equivalent to the numberJson property. | |
| privateUrl | string | Displays as the URL of the specified scheduler link as set on the Webhandle - gets formed by combining the domain and handle of the specified scheduler link. | |
| publish | boolean | Yes | Indicates whether or not the box signifying Publish Booking Site is checked - acts as a way to temporarily disable the schedulerLink from being active to clients without deleting it entirely. |
| reasonGroupList | string | Displays as a list of the names of any reason groups that are set to show on the specified scheduler link. | |
| reasonIdList | array | Displays as a list of the IDs of any reasons that are set to show on the specified scheduler link. | |
| reasonList | string | Displays as a list of usernames of any reasons that are set to show on the specified scheduler link. | |
| reasonSuperGroupList | string | Displays as a list of the names of any reason super groups that are set to show on the specified scheduler link. | |
| schedulerLinkExclusions | array | ||
| schedulerLinkId | integer | Yes, on PUT calls | Provides unique numeric ID of the specified scheduler link. |
| schedulerType | string | Yes | Displays as the scheduler type of the specified scheduler link - this property will be set to LINK if you are creating a scheduler link object by choosing to "Add New Booking Site" on the TimeTap website under Custom Booking Sites. It could also be set to LOCATION, LOCATION_GROUP, STAFF, REASON, or REASON_GROUP if you are creating the scheduler link from a specific object profile of the corresponding object type. |
| schedulerVersion | integer | Displays the version of the scheduler used by the specified scheduler link - the newer scheduler is version 5, but a few older accounts still use version 4. | |
| showPrivateGroup | boolean | Indicates whether or not the specified scheduler link is set to show private location groups and reason groups in its scheduler flow. | |
| showPrivateLocation | boolean | Indicates whether or not the specified scheduler link is set to show private locations in its scheduler flow. | |
| showPrivateReason | boolean | Indicates whether or not the specified scheduler link is set to show private services and classes in its scheduler flow. | |
| showPrivateStaff | boolean | Indicates whether or not the specified scheduler link is set to show private staff in its scheduler flow. | |
| showServiceGroup | boolean | Indicates whether or not the specified scheduler link is set to show reason super groups in its scheduler flow. | |
| showServiceSuperGroup | boolean | Indicates whether or not the specified scheduler link is set to show reason groups in its scheduler flow. | |
| skipWelcome | boolean | Indicates whether or not the specified scheduler link is set to skip the welcome page - if this property is left null, that means that the schedulerLink will pick up the values from the default scheduler on the account. | |
| staffIdList | integer | Displays as a list of the IDs of any staff that are connected to the specified scheduler link. | |
| staffList | array | Displays as a list of usernames of any staff that are set to show on the specified scheduler link. | |
| styleUrl | integer | Optional stylesheet url that can be applied to header of scheduler to override default styles; must be set as an HTTPS URL. | |
| vanity | boolean | Yes | Indicates whether or not you chose to set your own individual handle - if you do not, TimeTap will generate a unique alphanumeric code automatically. |
| welcomeText | string | Displays as what is set as the Welcome Text under Customizations in the specified scheduler link's profile - if this property is left null, that means that the schedulerLink will pick up the values from the default scheduler on the account. | |
| welcomeTitle | string | Displays as what is set as the Welcome Title under Customizations in the specified scheduler link's profile - if this property is left null, that means that the schedulerLink will pick up the values from the default scheduler on the account. |