Business

The Business API is used to access and modify the business object on your business' account. 

On this page




Business API Endpoints

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.




Business API Parameters


There are no parameters included with business calls.




Business API Request Body/Payloads

PUT /business
{
    "acceptOnlineAppointments": true,
    "autoCompleteOpenAppt": 7,
    "autoWaitListInviteBackoffice": false,
    "autoWaitListInvites": false,
    "billingInfoAdded": false,
    "billingProcessor:" "RECURLY",
    "billingToken": "3iviXdJCNLwnr46YTtQbTKhmhwH8hwQY",
    "businessId": 43111,
    "businessInfo": "(HTML text of billing info)",
    "businessName": "Dog Groomers Anonymous!",
    "checkinScreenJson": null,
    "clientRemindHrs": 24,
    "clientTags": null,
    "clientTextRemindHrs": 1,
    "country": {Country object for country of business - see Country API page},
    "createdDate": 1522268785000,
    "currency": {Currency object for currency of business - see Currency API page},
    "daysTrialExpires": null,
    "domain": "timetap.com",
    "domains": null,
    "emailFooter": "%STAFF_SIGNATURE%",
    "emailHeader": "(HTML text of email header)",
    "embedURL": "https://www.timetap.com/emb/43111",
    "externalId": null,
    "internalDisplayName": "Dog Groomers Anonymous",
    "internalName": null,
    "invoiceAddress": "bizzaddy",
    "invoiceDescription": null,
    "locale": "en-US",
    "logo": null,
    "miniWebsiteURL": "https://morgankearney.timetap.com",
    "parentBusinessId": null,
    "plan": {planId: 11, plan: "TimeTap Comp", planCode: "TTCOMP", resellerId: 3, optional: 0, planOrder: 0,…},
    "requireStaffConfirmation": true,
    "resellerId": 3,
    "schedulerVersion": 4,
    "sendEmailAutoComplete": false,
    "sendIcs": true,
    "sendWaitListInviteText": true,
    "staffRateLevelList": ["newbie", "experienced", "premium"],
    "staffRemindHrs": 24,
    "staffTextRemindHrs": 0,
    "status": "ACTIVE",
    "styleUrl": null,
    "teamName": null,
    "timeZone": {Timezone object for time zone of business - see Timezone API page},
    "twilioSendNumber": null,
    "useLocationGroup": true,
    "useLocationSuperGroup": null,
    "useReasonGroup": true,
    "waitListInviteWaitHours": 24,
    "waitListKeepOpenOnBooking": null,
    "webHandle": "MORGANKEARNEY"
}




Business API Responses

GET /business
{
    "acceptOnlineAppointments": true,
    "autoCompleteOpenAppt": 7,
    "autoWaitListInviteBackoffice": false,
    "autoWaitListInvites": false,
    "billingInfoAdded": false,
    "billingProcessor": "RECURLY",
    "billingToken": "3iviXdJCNLwnr46YTtQbTKhmhwH8hwQY",
    "businessId": 43111,
    "businessInfo": "(Text for business info)",
    "businessName": "Dog Groomers Anonymous",
    "clientRemindHrs": 24,
    "clientTextRemindHrs": 1,
    "country": {Country object for country of business - for more info, see Country API page},
    "createdDate": 152268785000,
    "currency": {Currency object for currency of business - for more info, see Currency API page},
    "emailFooter": "(Text for email footer)",
    "emailHeader": "(Text for email header)",
    "embedUrl": "https://www.timetap.com/emb/43111",
    "externalId": null,
    "internalDisplayName": "Dog Groomers Anonymous",
    "internalName": null,
    "invoiceAddress": null,
    "invoiceDescription": null,
    "locale": "en-US",
    "logo": null,
    "miniWebsiteURL": "https://joeschmo.timetap.com",
    "parentBusinessId": null,
    "requireStaffConfirmation": false,
    "sendEmailAutoComplete": false,
    "sendIcs": true,
    "sendWaitListInviteText": false,
    "staffRateLevelList": [
        "0": "newbie",
        "1": "experienced",
        "2": "premium"
    ],
    "staffRemindHrs": 24,
    "staffTextRemindHrs": 0,
    "styleUrl": null,
    "teamName": null,
    "timeZone": {Timezone object for timezone of business - see Timezones API page},
    "twilioSendNumber": null,
    "useLocationGroup": true,
    "useLocationSuperGroup": null,
    "useReasonGroup": true,
    "waitListInviteWaitHrs": 24,
    "waitListKeepOpenOnBooking": null,
    "webHandle": "JoeSchmo"
}
PUT /business
{
    "acceptOnlineAppointments": true,
    "autoCompleteOpenAppt": 7,
    "autoWaitListInviteBackoffice": false,
    "autoWaitListInvites": false,
    "businessId": 43111,
    "businessInfo": "(Text for business info)",
    "businessName": "Dog Groomers Anonymous",
    "clientRemindHrs": 24,
    "clientTextRemindHrs": 1,
    "country": {
        "country": "United States",
        "countryCode": "US",
        "countryId": 1
    },
    "createdDate": 152268785000,
    "currency": {
        "currencyCode": "USD",
        "currencyId": 1,
        "currencyName": "US Dollars",
        "prefix": "$",
    },
    "emailFooter": "(Text for email footer)",
    "emailHeader": "(Text for email header)",
    "embedUrl": "https://www.timetap.com/emb/43111",
    "externalId": null,
    "internalDisplayName": "Dog Groomers Anonymous",
    "internalName": null,
    "invoiceAddress": null,
    "invoiceDescription": null,
    "locale": "en-US",
    "logo": null,
    "miniWebsiteURL": "https://joeschmo.timetap.com",
    "parentBusinessId": null,
    "requireStaffConfirmation": false,
    "sendEmailAutoComplete": false,
    "sendIcs": true,
    "sendWaitListInviteText": false,
    "staffRateLevelList": [
        "0": "newbie",
        "1": "experienced",
        "2": "premium"
    ],
    "staffRemindHrs": 24,
    "staffTextRemindHrs": 0,
    "styleUrl": null,
    "teamName": null,
    "timeZone": {Timezone object for timezone of business - see Timezones API page},
    "twilioSendNumber": null,
    "useLocationGroup": true,
    "useLocationSuperGroup": null,
    "useReasonGroup": true,
    "waitListInviteWaitHrs": 24,
    "waitListKeepOpenOnBooking": null,
    "webHandle": "JoeSchmo"
}




Business Object Values

Property nameTypeRequiredWritableDescription
acceptOnlineAppointmentsboolean
YesIndicates 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.
autoCompleteOpenApptinteger
YesDisplays 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.
autoWaitListInviteBackofficeboolean
YesIndicates whether or not the specified business auto invites waitlisted clients when a staff member cancels an appointment that other clients were waitlisted for.
autoWaitListInvitesboolean
YesIndicates whether or not the specified business auto invites waitlisted clients when a client cancels an appointment that other clients were waitlisted for.
billingInfoAddedboolean

Indicates whether or not the specified business has its billing information added to the account.
billingProcessorstring

Displays as the billing processor that is set up for the specified business. Possible values include "RECURLY" and "INVOICE".
billingTokenstring

Displays as the billing token used by the specified business.
businessIdintegerYes
Provides unique numeric ID for the specified business.
businessInfostring
YesDisplays as what is set to display on text info & scheduler of the specified business.
businessNamestringYesYesDisplays as the name of the specified business.
clientRemindHrsinteger
YesDisplays as the default value for how many hours before an appointment the reminder email is set to send to clients.
clientTextRemindHrsinteger
YesDisplays as the default value for how many hours before an appointment the reminder text message is set to send to clients.
countryobjectYesYesDisplays as the country the specified business is set to - for more info, see Country API page.
createdDateinteger

Displays as date the specified business/account was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
currencyobjectYesYesDisplays as the currency the specified business is set to use - for more info, see Currency API page.
daysTrialExpiresinteger

Provides the number of days until the specified business' trial period expires. 
domainstring

Displays as the domain used by the specified business. Should display as "timetap.com" under normal circumstances.
emailFooterstring
YesDisplays as what is sent in the email footer for all emails sent by the specified business.
emailHeaderstring
YesDisplays as what is sent in the email header for all emails sent by the specified business.
embedURLstring

Displays as embeddable URL for the responsive scheduler.
externalIdstring
YesCan be set to unique alphanumeric ID for any external account belonging to the specified business.
internalDisplayNamestringYesYesIf 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.
internalNamestring
YesDisplays as the business name that staff of the specified business see.
invoiceAddressstring
YesDisplays as the address set for invoices of the specified business.
invoiceDescriptionstring
YesDisplays as the description for line items added to invoices of the specified business.
localestringYesYesDisplays as the locale the specified business is set to - for more info, see Locale API page.
logostring
YesDisplays as the logo of the specified business (should be formatted as a URL with https).
miniWebsiteURLstringYes
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.
parentBusinessIdinteger

Provides unique numeric ID for any parent business the specified business falls under.
requireStaffConfirmationboolean
YesIndicates whether or not the specified business is set to require staff confirmation of any appointments requests made through the scheduler.
sendEmailAutoCompleteboolean
YesIndicates 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.
sendIcsboolean
YesIndicates whether or not the specified business is set to send an ICS file attachment with appropriate appointment template emails (such as confirmation, reschedule).
sendWaitListInviteTextboolean
YesIndicates whether or not the specified business is set to send text message waitlist invites.
staffRateLevelListarray
YesDisplays as a list of the names set for the different levels for staff members. 
staffRemindHrsinteger
YesDisplays as the default value for how many hours before an appointment the reminder email is set to send to staff.
staffTextRemindHrsinteger
YesDisplays as the default value for how many hours before an appointment the reminder text message is set to send to staff.
styleUrlstring
YesOptional stylesheet url that can be applied to header of scheduler to override default styles; must be set to an HTTPS URL.
teamNamestring
YesDisplays as what is set as the specified business' team name.
timeZoneobjectYesYesDisplays as the timezone the specified business uses - for more info, see Timezones API page.
twilioSendNumberinteger

Displays as the Twilio number that reminder text messages are sent from that's associated with the specified business.
useLocationGroupboolean
YesIndicates whether or not the specified business is set to use location groups.
useLocationSuperGroupboolean
YesIndicates whether or not the specified business is set to use location super groups.
useReasonGroupboolean
YesIndicates whether or not the specified business is set to use reason groups.
waitListInviteWaitHoursinteger
YesDisplays 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.
waitListKeepOpenOnBookingboolean
YesIndicates 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.
webHandlestring
YesDisplays 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.