Using Parameters to Control the Scheduler

Owned by Joel Kearney
Last updated: Aug 22, 2023

Unlike the other pages in this API documentation, this page is not meant to document an individual API and describe its different endpoints. Instead, it lists all the parameters that can be passed to the client scheduler to create/load different clients or to control the scheduler that gets loaded.  

Please note that the parameter values must be URI encoded before they can be passed.

On this page



Client Parameters 

Return to top

Client parameters are used to create or load different clients. When these parameters get passed, the client that matches the values entered gets looked up or a new client with those values gets created. 

ParameterTypeDescription
cidintegerLoads an existing client or creates a new one with the specified clientId value saved on his/her Clients object.
clientAddress1stringLoads an existing client or creates a new one with the specified address1 value saved on his/her Clients object.
clientAddress2stringLoads an existing client or creates a new one with the specified address2 value saved on his/her Clients object.
clientCellPhonestringLoads an existing client or creates a new one with the specified cellPhone value saved on his/her Clients object.
clientCitystringLoads an existing client or creates a new one with the specified city value saved on his/her Clients object.
clientEmailstringLoads an existing client or creates a new one with the specified emailAddress value saved on his/her Clients object.
clientFirstNamestringLoads an existing client or creates a new one with the specified firstName value saved on his/her Clients object.
clientFullNamestringLoads an existing client or creates a new one with the specified fullName value saved on his/her Clients object.
clientHomePhonestringLoads an existing client or creates a new one with the specified homePhone value saved on his/her Clients object.
clientLastNamestringLoads an existing client or creates a new one with the specified lastName value saved on his/her Clients object.
clientStatestringLoads an existing client or creates a new one with the specified state value saved on his/her Clients object.
clientZipintegerLoads an existing client or creates a new one with the specified zip value saved on his/her Clients object.
externalUserNamestringLoads an existing client or creates a new one with the specified externalUserName value saved on his/her Clients object.



Other Parameters

Return to top

The other parameters that can be passed change the behavior of the scheduler.

For example: if you were to pass "https://www.timetap.com/book/testbiz&id=23324" to the URL in a browser, it would pull up a scheduler with the handle "testbiz" for the business with a business ID of 23324. To add more parameters, you need to separate each one with a "&" symbol.

ParameterTypeDescription
aidintegerLoads a web scheduler already set up for the appointment with the specified appointmentId.
cfstring

Loads a web scheduler already set up with the specified custom fields filled out as denoted in the URL.

cidintegerLoads a web scheduler already set up for the client with the specified clientId.
clientTagsstringPass in a comma separated string of clientTags in order to sort the list of reasons shown to only those that contain the specified clientTags
couponstringLoads a web scheduler already set up to use the coupon with the specified couponCode.
createdBystringDisplays who should get assigned to the specified createdBy field.
csidintegerLoads a web scheduler already set up for the coordinator staff with the specified coordinatorStaffId.
euidintegerLoads a web scheduler already set up for the external user with the specified externalUserId.
gidintegerLoads a web scheduler already set up for either the location group or reason group with the specified groupId.
idintegerLoads a web scheduler already set up for the business with the specified businessId.
iidintegerLoads a web scheduler already set up for the invoice with the specified invoiceId.
ivtstringLoads a web scheduler already set up for the client with the specified invitationUUId.
jridintegerLoads a web scheduler already set up for the job requisition with the specified jobRequisitionId.
lidintegerLoads a web scheduler already set up for the location with the specified locationId.
notestring

Displays the specified note to get added to comments when appointment is saved.

refIdintegerLoads a web scheduler already set up for the referral with the specified referralId.
ridintegerLoads a web scheduler already set up for the reason with the specified reasonId.
schstringLoads a web scheduler already set up for the client with the specified ssoClientHash.
sfcidintegerLoads a web scheduler already set up for the client with the specified salesforceContactId.
sflidintegerLoads a web scheduler already set up for the client with the specified salesforceLeadId.
sfopidintegerLoads a web scheduler already set up for the client with the specified salesforceOpportunityId.
sidintegerLoads a web scheduler already set up for the staff with the specified staffId.



Using Custom Fields

Return to top


For an example of how to format a scheduler URL so that it has a custom field filled out, we will use my personal https://morgankearney.com scheduler and the custom field "Nickname". To correctly add a custom field parameter to a scheduler URL, you will need to add a prefix of "CF_" followed by the contents of the specified custom field's Email Tag. So to link a client to a scheduler with the Nickname filled out as "J", you would post the URL as https://morgankearney.timetap.com/?CF_NICKNAME=J#/. 

Don't forget to make sure that when you create the custom field, you set its "Email tag" as the name of that custom field, in this case "NICKNAME".