Using Parameters to Control the Scheduler

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 URIencoded before they can be passed.

On this page




Client Parameters 

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 this clientId value saved on his/her Clients object.
clientAddress1stringLoads an existing client or creates a new one with this address1 value saved on his/her Clients object.
clientAddress2stringLoads an existing client or creates a new one with this address2 value saved on his/her Clients object.
clientCellPhonestringLoads an existing client or creates a new one with this cellPhone value saved on his/her Clients object.
clientCitystringLoads an existing client or creates a new one with this city value saved on his/her Clients object.
clientEmailstringLoads an existing client or creates a new one with this emailAddress value saved on his/her Clients object.
clientFirstNamestringLoads an existing client or creates a new one with this firstName value saved on his/her Clients object.
clientFullNamestringLoads an existing client or creates a new one with this fullName value saved on his/her Clients object.
clientHomePhonestringLoads an existing client or creates a new one with this homePhone value saved on his/her Clients object.
clientLastNamestringLoads an existing client or creates a new one with this lastName value saved on his/her Clients object.
clientStatestringLoads an existing client or creates a new one with this state value saved on his/her Clients object.
clientZipintegerLoads an existing client or creates a new one with this zip value saved on his/her Clients object.
externalUserNamestringLoads an existing client or creates a new one with this externalUserName value saved on his/her Clients object.




Other Parameters

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 this appointmentId.
cidintegerLoads a web scheduler already set up for the client with this clientId.
clientTagsstring[]Pass in a comma separated string of clientTags in order to sort the list of reasons shown to only those that contain those clientTags
couponstringLoads a web scheduler already set up to use the coupon with this couponCode.
createdBystringDisplays who should get assigned to the createdBy field.
csidintegerLoads a web scheduler already set up for the coordinator staff with this coordinatorStaffId.
euidintegerLoads a web scheduler already set up for the external user with this externalUserId.
gidintegerLoads a web scheduler already set up for either the location group or service group with this groupId.
idintegerLoads a web scheduler already set up for the business with this businessId.
iidintegerLoads a web scheduler already set up for the invoice with this invoiceId.
ivtstringLoads a web scheduler already set up for the client with this invitationUUId.
jridintegerLoads a web scheduler already set up for the job requisition with this jobRequisitionId.
lidintegerLoads a web scheduler already set up for the location with this locationId.
notestringDisplays note to get added to comments when appointment is saved.
refIdintegerLoads a web scheduler already set up for the referral with this referralId.
ridintegerLoads a web scheduler already set up for the reason with this reasonId.
schstringLoads a web scheduler already set up for the client with this ssoClientHash.
sfcidintegerLoads a web scheduler already set up for the client with this salesforceContactId.
sflidintegerLoads a web scheduler already set up for the client with this salesforceLeadId.
sfopidintegerLoads a web scheduler already set up for the client with this salesforceOpportunityId.
sidintegerLoads a web scheduler already set up for the staff with this staffId.