Enterprise Child

The Enterprise Child API is used to create new child accounts on your enterprise account. You should use the PUT /business API call to make edits to an enterprise child account once it has been created.

On this page




Enterprise Child API Endpoints

These are the endpoints that are available under the /enterpriseChild path, which is used to create new child accounts on your Enterprise accounts.

Endpoint

Description

GET /enterprise/childrenReturns all enterprise child objects associated with an account in array format.
POST /enterpriseChild

Creates a new enterpriseChild object.

Request body/payload: Must pass an enterpriseChild object.

For these calls, you need to pass an enterpriseChild object with all required fields and any fields you want to set filled in in the body of the payload. We have an example of an enterpriseChild object in the responses section below and have indicated the required fields in the object values table at the bottom of this page.

DELETE /enterpriseChild/{businessId}Deletes an enterprise child account. 




Enterprise Child API Parameters


Data points passed on in the request URL portion of the API call that are used to filter the data being requested.

Parameter

TypeEndpoints to be used with

Description

businessIdCloneFromintegerPOST /enterpriseChildShould be set as the businessId of the enterprise parent account that the specified enterprise child account is being cloned from.
copyEmailsbooleanPOST /enterpriseChildThis flag should be set to true if you have opted to copy the emails from the enterprise parent to the child account being created.
copyLocationbooleanPOST /enterpriseChildThis flag should be set to true if you have opted to copy the locations from the enterprise parent to the child account being created.
copyReasonsbooleanPOST /enterpriseChildThis flag should be set to true if you have opted to copy the services & classes from the enterprise parent to the child account being created.
copySecurityRolebooleanPOST /enterpriseChildThis flag should be set to true if you have opted to copy the security roles from the enterprise parent to the child account being created.
copyStaffbooleanPOST /enterpriseChildThis flag should be set to true if you have opted to copy the staff from the enterprise parent to the child account being created.
externalIdstringPOST /enterpriseChildShould be set as the externalld of the enterpriseChild account to be created.
internalNamestringPOST /enterpriseChildShould be set as the internalName of the enterpriseChild account to be created.
namestringPOST /enterpriseChildShould be set as the name of the enterpriseChild account to be created.
parentBusinessIdintegerPOST /enterpriseChildShould be set as the businessId of the enterprise parent account that the specified enterprise child account is being created on.
teamNamestringPOST /enterpriseChildShould be set as the teamName of the enterpriseChild account to be created.
timezonestringPOST /enterpriseChildShould be set as the timezone of the enterpriseChild account to be created.
webhandlestringPOST /enterpriseChildShould be set as the webhandle of the enterpriseChild account to be created.
webhookUrlstringPOST /enterpriseChildShould be set as the desired URL of the enterpriseChild account to be created.




Enterprise Child API Request Body/Payloads


The objects below represent the minimum viable objects to pass that are needed to create an enterpriseChild 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.

POST /enterpriseChild
{
    "businessIdCloneFrom": null,
    "internalName": "Branch3_DEV",
    "name:" "Branch3_DEV",
    "parentBusinessId": 20232,
    "teamName": "branch 3 dev",
    "timeZone": {Timezone object for timezone of enterprise child - for more info, see Timezone API page},
    "timezone": "America/New_York",
    "webHandle": "dev3branch"
}




Enterprise Child API Responses

GET /enterprise/children
[{
    "acceptOnlineAppointments": true,
    "autoCompleteOpenAppt": 7,
    "autoWaitListInviteBackoffice": false,
    "autoWaitListInvites": false,
    "billingInfoAdded": false,
    "billingProcessor": "RECURLY",
    "billingToken": "Y9T3faHCxGifm9GZ4zLjLTkvoCHrVcVe",
    "businessId": 20233,
    "businessInfo": "{Text for business info}",
    "businessName": "Branch1_PRD",
    "checkinScreenJson": null,
    "clientRemindHrs": 24,
    "clientTags": null,
    "clientTextRemindHrs": 1,
    "country": {Country object for country of enterprise child - for more info, see Country API page},
    "createdDate": 1647890132058,
    "currency": {Currency object for currency of enterprise child - for more info, see Currency API page},
    "domain": "timetap.com",
    "domains": null,
    "emailFooter": "{Text for email footer}",
    "emailHeader": "{Text for email header}",
    "embedURL": "https://www.devtap.us/emb/20233",
    "externalId": null,
    "externalUrl": "https://kyle.timetap.com/#/",
    "internalDisplayName": "Branch1_PRD",
    "internalName": "Branch1_PRD",
    "invoiceAddress": null,
    "invoiceDescription": null,
    "locale": "en-US",
    "logo: null,
    "miniWebsiteURL": "https://branch1prd.devtap.us",
    "parentBusinessId": 20232,
    "requireStaffConfirmation": false,
    "resellerId": 3,
    "roomNumberOnWorkingHours": null,
    "schedulerVersion": 5,
    "sendEmailAutoComplete": false,
    "sendIcs": true,
    "sendWaitListInviteText": false,
    "staffRateLevelList": null,
    "staffRemindHrs": 24,
    "staffTextRemindHrs": null,
    "status": "ACTIVE",
    "styleUrl": null,
    "teamName": "Branch1_PRD",
    "timeZone": {Timezone object for timezone of enterprise child - for more info, see Timezones API page},
    "twilioSendNumber": null,
    "useLocationGroup": null,
    "useLocationSuperGroup": null,
    "useReasonGroup": null,
    "waitListInviteUnavailable": false,
    "waitListInviteWaitHours": 24,
    "waitListKeepOpenOnBooking": null,
    "webHandle": "BRANCH1PRD"
}]
POST /enterpriseChild
{
    "acceptOnlineAppointments": true,
    "autoCompleteOpenAppt": 7,
    "autoWaitListInviteBackoffice": false,
    "autoWaitListInvites": false,
    "billingInfoAdded": false,
    "billingProcessor": "INVOICE",
    "billingToken": "Y9T3faHCxGifm9GZ4zLjLTkvoCHrVcVe",
    "businessId": 20292,
    "businessInfo": "{Text for business info}",
    "businessName": "Branch3_DEV",
    "checkinScreenJson": null,
    "clientRemindHrs": 24,
    "clientTags": null,
    "clientTextRemindHrs": 1,
    "country": {Country object for country of enterprise child - for more info, see Country API page},
    "createdDate": 1652109112403,
    "currency": {Currency object for currency of enterprise child - for more info, see Currency API page},
    "domain": "timetap.com",
    "domains": null,
    "emailFooter": "{Text for email footer}",
    "emailHeader": "{Text for email header}",
    "embedURL": "https://www.timetap.com/emb/20292",
    "externalId": null,
    "externalUrl": null,
    "internalDisplayName": "Branch3_DEV",
    "internalName": "Branch3_DEV",
    "invoiceAddress": null,
    "invoiceDescription": null,
    "locale": "en-US",
    "logo": null,
    "miniWebsiteURL": "https://dev3branch.timetap.com",
    "parentBusinessId": 20232,
    "requireStaffConfirmation": false,
    "resellerId": 3,
    "roomNumberOnWorkingHours": null,
    "schedulerVersion": 5,
    "sendEmailAutoComplete": false,
    "sendIcs": true,
    "sendWaitListInviteText": false,
    "staffRateLevelList": null,
    "staffRemindHrs": 24,
    "staffTextRemindHrs": null,
    "status": "ACTIVE",
    "styleUrl": null,
    "teamName": "branch 3 dev",
    "timeZone": {Timezone object for timezone of enterprise child - for more info, see Timezone API page},
    "twilioSendNumber": null,
    "useLocationGroup": null,
    "useLocationSuperGroup": null,
    "useReasonGroup": null,
    "waitListInviteUnavailable": false,
    "waitListInviteWaitHours": 24,
    "waitListKeepOpenOnBooking": null,
    "webHandle": "DEV3BRANCH"
}




Enterprise Child Object Values

Property nameTypeRequiredWritableDescription
acceptOnlineAppointmentsboolean
YesIndicates whether or not specified enterprise child is set up to accept appointments online. If false, the miniwebsite will not be an active link.
autoCompleteOpenApptinteger
YesDisplays as number of days after an appointment it should auto complete; if it is set to null, appointments will not be auto marked as completed.
autoWaitListInviteBackofficeboolean
YesIndicates whether or not specified enterprise child auto invites waitlisted clients when a staff member cancels an appointment that other clients were waitlisted for.
autoWaitListInvitesboolean
YesIndicates whether or not specified enterprise child auto invites waitlisted clients when a client cancels an appointment that other clients were waitlisted for.
billingInfoAddedboolean

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

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

Displays as the billing token used by the specified enterprise child.
businessIdintegerYes
Provides unique numeric ID for specified enterprise child.
businessInfostring
YesDisplays as what is set to display on text info & scheduler of specified enterprise child.
businessNamestringYesYesDisplays as the name of specified enterprise child.
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 specified enterprise child is set to - for more info, see Country API page.
createdDateinteger

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

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

Displays as embeddable URL for responsive scheduler.
externalIdstring
YesCan be set to unique alphanumeric ID for any external account belonging to specified enterprise child.
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 see of specified enterprise child see.
invoiceAddressstring
YesDisplays as the address set for invoices of specified enterprise child.
invoiceDescriptionstring
YesDisplays as the description for line items added to invoices of specified enterprise child.
localestringYesYesDisplays as the locale specified enterprise child is set to - for more info, see Locale API page.
logostring
YesDisplays as the logo of specified enterprise child (should be formatted as a url with https).
miniWebsiteURLstringYes
Displays as the URL of specified enterprise child's 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 specified enterprise child falls under.
requireStaffConfirmationboolean
YesIndicates whether or not specified enterprise child is set to require staff confirmation of appointment requests made through the scheduler.
sendEmailAutoCompleteboolean
YesIndicates whether or not emails will be automatically sent out by the enterprise child. Works with autoCompleteOpenAppt property also on enterprise child object and will send the email out when the appointment auto completes.
sendIcsboolean
YesIndicates whether or not specified enterprise child is set to send ICS file attachment on appointment template emails that have an ICS attachment (confirmation, reschedule).
sendWaitListInviteTextboolean
YesIndicates whether or not specified enterprise child 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 specified enterprise child's team name.
timeZoneobjectYesYesDisplays as the timezone specified enterprise child uses - for more info, see Timezones API page.
twilioSendNumberinteger

Displays as the Twilio send number associated with specified enterprise child.
useLocationGroupboolean
YesIndicates whether or not specified enterprise child is set to use location groups.
useLocationSuperGroupboolean
YesIndicates whether or not specified enterprise child is set to use location super groups.
useReasonGroupboolean
YesIndicates whether or not specified enterprise child 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 to try and claim 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 enterprise child object with the new webhandle string set within this property.