Parameters for dynamic links

Find the types of information you can use in dynamic links

Parameters are pieces of information you can add to scheduling links to prefill forms or make selections for your clients.

This guide lists the parameters you can use in dynamic links and explains where to find each. To learn more about how dynamic links work, visit Dynamic linking and Building dynamic links.

Note: The parameters below are case-sensitive.

Appointment type

Specifying an appointment type preselects the appointment type for your client.

Format

appointmentType=12345

Finding your parameter

To find the parameter for one of your appointment types:

1. In Acuity, click Appointment Types.
2. For the appointment type you want to include, click Direct Scheduling Link.
3. Your parameter will appear just after the question mark in the URL. 

Calendar

Specifying a calendar preselects the calendar for your client.

Format

calendarID=12345

Finding your parameter

To find the parameter for one of your calendars:

1. In Acuity, click Availability.
2. For the calendar you want to include, click Direct Scheduling Link.
3. Your parameter will appear just after the question mark in the URL.

First name

Specifying a first name prefills the first name field for the client.

Format

firstName=John

Last name

Specifying a last name prefills the last name field for the client.

Format

lastName=Doe

Email address

Specifying an email address prefills the email field for the client.

Format

email=example@squarespace.com

Phone number

Specifying a phone number prefills the phone field for the client.

Format

phone=919-555-3944

Certificate

Applies the code from a coupon, package, gift certificate or subscription.

Format

certificate=EXAMPLECODE

Location

Specifying a location limits the calendar selection step to calendars that have the specified location listed in their settings.

Format

location=123%20Main%20St.

Finding your parameter

To find the parameter for one of your locations:

1. In Acuity, click Availability.
2. For the address you want to include, click Direct Scheduling Link.
3. Your parameter will appear just after the question mark in the URL.

Multiple appointment types

Specifying multiple appointment types limits your clients to choosing from the appointment types you’ve listed.

Format

appointmentType[]=123456&appointmentType[]=789012

Appointment categories

Specifying an appointment type category limits your clients to choosing from appointments in the category you choose.

Format

appointmentType=category:Example%20Category%20Name

Finding your parameter

To find the parameter for one of your categories:

1. In Acuity, click Appointment Type.
2. For the category you want to include, click Direct Scheduling Link.
3. Your parameter will appear just after the question mark in the URL.

Quantity

Specifying a quantity prefills the quantity field if you have a class or appointment type for which clients can book more than one slot.

Format

quantity=2

Custom form fields

Specifying form field answers prefills answers to custom intake forms. These fields can be on client-facing forms or internal forms that clients never see.

To learn more about using internal forms to track referral sources, visit Tracking appointment referral sources.

Format

The format of prefilled form answers varies slightly based on the type of question tied to the form field.

Finding your field number

1. In Acuity, click Client Email.
2. In the template editor, click Insert field.
3. Scroll down to the Intake form answers section, and click the question you’re interested in. The code for your question will appear in your email template.
4. Copy the form number only, and use it to build your parameter. Do not copy the word form from the email template.
5. Close the email template without saving changes.

Appointment date and time

You can specify the date and time of an appointment in a dynamic link. Acuity's developer documentation covers the proper format of this parameter. This functionality is outside our scope of support.