Business
- Joel Morgan Kearney (Unlicensed)
- Joel Kearney
- Lucy Barber (Unlicensed)
Owned by Joel Morgan Kearney (Unlicensed)
These are the endpoints that are available under the /business path, which provides information about the account settings on your business account.
Endpoint | Description |
|---|---|
GET /business | Returns business object that represents a business' account. |
| PUT /business | Updates specified business object. Request body/payload: Must pass a business object with all desired changes made in the request body/payload. For these calls, you need to pass a business object with all required fields and any fields you want to update filled in the body of the payload - make sure to include the proper businessId. We have an example of a business object in the responses section below and have indicated the required fields in the object values table at the bottom of this page. |
There are no parameters included with business calls.
The objects below represent the minimum viable objects to pass that are needed to update a business 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 | Writable | Description |
|---|---|---|---|---|
| acceptOnlineAppointments | boolean | Yes | Indicates whether or not the specified business is set up to accept appointments online. If false, the mini website/scheduler will not be an active link. | |
| autoCompleteOpenAppt | integer | Yes | Displays as the number of days after an appointment that it should auto complete; if set to null, appointments will not be auto marked as completed. | |
| autoWaitListInviteBackoffice | boolean | Yes | Indicates whether or not the specified business auto invites waitlisted clients when a staff member cancels an appointment that other clients were waitlisted for. | |
| autoWaitListInvites | boolean | Yes | Indicates whether or not the specified business auto invites waitlisted clients when a client cancels an appointment that other clients were waitlisted for. | |
| billingInfoAdded | boolean | Indicates whether or not the specified business has its billing information added to the account. | ||
| billingProcessor | string | Displays as the billing processor that is set up for the specified business. Possible values include "RECURLY" and "INVOICE". | ||
| billingToken | string | Displays as the billing token used by the specified business. | ||
| businessId | integer | Yes | Provides unique numeric ID for the specified business. | |
| businessInfo | string | Yes | Displays as what is set to display on text info & scheduler of the specified business. | |
| businessName | string | Yes | Yes | Displays as the name of the specified business. |
| checkinScreenJson | string | Displays the contents of the check-in screen in JSON form. | ||
| clientRemindHrs | integer | Yes | Displays as the default value for how many hours before an appointment the reminder email is set to send to clients. | |
| clientTags | string | Displays a string of all client tags on the specified business. | ||
| clientTextRemindHrs | integer | Yes | Displays as the default value for how many hours before an appointment the reminder text message is set to send to clients. | |
| country | object | Yes | Yes | Displays as the country the specified business is set to - for more info, see Country API page. |
| createdDate | integer | Displays as date the specified business/account was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. | ||
| currency | object | Yes | Yes | Displays as the currency the specified business is set to use - for more info, see Currency API page. |
| daysTrialExpires | integer | Provides the number of days until the specified business' trial period expires. | ||
| domain | string | Displays as the domain used by the specified business. Should display as "timetap.com" under normal circumstances. | ||
| domains | string | Displays as the domains used by the specified business if there are more than one. Should display as null under normal circumstances. | ||
| emailFooter | string | Yes | Displays as what is sent in the email footer for all emails sent by the specified business. | |
| emailHeader | string | Yes | Displays as what is sent in the email header for all emails sent by the specified business. | |
| embedURL | string | Displays as embeddable URL for the responsive scheduler. | ||
| externalId | string | Yes | Can be set to unique alphanumeric ID for any external account belonging to the specified business. | |
| externalUrl | string | Displays as the external URL for the specified business. | ||
| internalDisplayName | string | Yes | Yes | If businessName is filled out but internalName is empty, internalDisplayName would be the same as the businessName; if the internalName is not empty, then the internalDisplayName would be the same as the internalName. |
| internalName | string | Yes | Displays as the business name that staff of the specified business see. | |
| invoiceAddress | string | Yes | Displays as the address set for invoices of the specified business. | |
| invoiceDescription | string | Yes | Displays as the description for line items added to invoices of the specified business. | |
| locale | string | Yes | Yes | Displays as the locale the specified business is set to - for more info, see Locale API page. |
| logo | string | Yes | Displays as the logo of the specified business (should be formatted as a URL with https). | |
| miniWebsiteURL | string | Yes | Displays as the URL of the specified business' TimeTap-provided web scheduler. This property cannot be written over. Please see webhandle property below in this table for information on how to set this value. | |
| parentBusinessId | integer | Provides unique numeric ID for any parent business the specified business falls under. | ||
| plan | object | Displays as the plan of the specified business. | ||
| requireStaffConfirmation | boolean | Yes | Indicates whether or not the specified business is set to require staff confirmation of any appointments requests made through the scheduler. | |
| resellerId | integer | Provides unique numeric ID of the specified business' reseller. | ||
| roomNumberOnWorkingHours | ||||
| schedulerVersion | integer | Provides the scheduler version that the specified business uses. | ||
| sendEmailAutoComplete | boolean | Yes | Indicates whether or not emails will be automatically sent out by the specified business. Works with autoCompleteOpenAppt property also on business object and will send the email out when the appointment auto completes. | |
| sendIcs | boolean | Yes | Indicates whether or not the specified business is set to send an ICS file attachment with appropriate appointment template emails (such as confirmation, reschedule). | |
| sendWaitListInviteText | boolean | Yes | Indicates whether or not the specified business is set to send text message waitlist invites. | |
| staffRateLevelList | array | Yes | Displays as a list of the names set for the different levels for staff members. | |
| staffRemindHrs | integer | Yes | Displays as the default value for how many hours before an appointment the reminder email is set to send to staff. | |
| staffTextRemindHrs | integer | Yes | Displays as the default value for how many hours before an appointment the reminder text message is set to send to staff. | |
| status | string | Displays as the status of the specified business account. | ||
| styleUrl | string | Yes | Optional stylesheet url that can be applied to header of scheduler to override default styles; must be set to an HTTPS URL. | |
| teamName | string | Yes | Displays as what is set as the specified business' team name. | |
| timeZone | object | Yes | Yes | Displays as the timezone the specified business uses - for more info, see Timezones API page. |
| twilioSendNumber | integer | Displays as the Twilio number that reminder text messages are sent from that's associated with the specified business. | ||
| useLocationGroup | boolean | Yes | Indicates whether or not the specified business is set to use location groups. | |
| useLocationSuperGroup | boolean | Yes | Indicates whether or not the specified business is set to use location super groups. | |
| useReasonGroup | boolean | Yes | Indicates whether or not the specified business is set to use reason groups. | |
| waitlistInviteUnavailable | boolean | Indicates whether or not the specified business has waitlist invites available. | ||
| waitListInviteWaitHours | integer | Yes | Displays as the number of hours a waitlist hold will stay on the calendar for clients who were invited to claim the waitlist slot before it is removed and the slot is opened back up for public booking. | |
| waitListKeepOpenOnBooking | boolean | Yes | Indicates whether after a waitlist registrant claims an appointment from a waitlist invitation, their waitlist registration should remain Open instead of Booked; If property set to true then the waitlist registration will remain open and if/when the other times the client is waitlisted for become available they will receive invitations for those times as well. If false then once a client claims an appointment from 1 time they were waitlisted for within a waitlist registration set, then that waitlist registration will be set to a status of Booked and they will no longer be notified if other times they waitlisted for become available. | |
| webHandle | string | Yes | Displays as the prefix for the business's miniWebsiteURL property above; if you want to change it, make a call to POST business/validate/webHandle and pass what you want to change it to in the body of the post. That call will return whether or not the requested webhandle is available or if it is already being used by another account on TimeTap. If it is valid, then you can update the business object with the new webhandle string set within this property. |