ScheduleOnce URL parameters and processing rules

When Customer data is passed via URL parameters, you can share your Booking page or Master page using Personalized links (URL parameters), or publish them on your website using Web form integration.

In this article, you will learn about the supported ScheduleOnce URL parameters and processing rules.

ScheduleOnce System fields

The following table lists all supported ScheduleOnce URL parameters (System fields, Custom fields and Booking form instructions), and the recommended character limit for each one.

Field name URL syntax Description Recommended character limit
Name &name= The Customer’s name 100
Email &email= The Customer’s email 100
Company &company= The Customer’s company name 100
Mobile &mobile= The Customer’s mobile number 20
Phone &phone= The Customer’s phone number 100
Subject &subject= The meeting’s subject 200
Note &note= A booking note 200
{Single-line text field}* &{field_name}= A 'Single-line text field' custom field 200
{Multi-line text field}* &{field_name}= A 'Multi-line text field' custom field 200
{Dropdown}* &{field_name}=

A 'Dropdown' custom field.

Dropdown values are case insensitive.

200
Skip** &skip= A Booking form skipping instruction.

This field can take a value of 1 or 0, where 1 means YES and 0 means NO.
 

* Custom fields  ** See URL parameters processing rules

Note: URLs have a 2,000 character limit, so you need to make sure you include the most important custom fields and keep to the recommended character limits described in the table above. You need to pay special attention to the Note field and 'Multi-line text field' custom fields, as these fields can easily become big.

ScheduleOnce Custom fields

URL parameters also support custom fields. You can pass multiple Custom fields as URL parameters. To find the field name of your custom fields,

  1. Go to Setup and open the left sidebar.
  2. Open the Booking forms editor and choose your Booking form on the left panel.
  3. Expand the Custom fields panel on the right and locate your custom field. The URL parameter is shown the Name (See Figure 1).
  4. Add the Name to your URL:

    “&{ScheduleOnce Custom field Name}={Value}”

    E.g. a static link with a ‘hobby’ custom attribute might look like this “&hobby=Basketball” and a dynamic link might look like this “&hobby=*|Hobby|*”

    Note that if you choose to add a Custom field Name that contains spaces, you will need to encod the spaces with "%20" (i.e. the standard URL encoding method).


Figure 1: Custom field in the Booking forms editor

 

Note: Only single-line text fields, multi-line text fields and dropdown fields are supported (i.e. checkboxes and attachments are not supported).

URL parameters processing rules

  • General

    • URL parameters that are not supported will be ignored.
    • โ€‹Field names are always case insensitive, i.e. “Skip” will be treated the same as “skip”.
    • Field values are case sensitive, i.e. “John” is different than “john”, except for dropdown fields where values are case insensitive.
    • The order of the URL parameters is not relevant. I.e. ?name=John&email=john@c.com is the same as ?email=john@c.com&name=John
    • Using the ‘skip=0’ parameter or not using it at all, will instruct the Booking form to always be displayed.
    • When the 'Skip' parameter is used and the Booking form contains the Mobile phone field with a checked 'Enable SMS' checkbox, the SMS notification opt-in/opt-out will be displayed when the Customer chooses a time for the booking. Booking form skipping can be used with personalized linksweb form integration and login integrationLearn more about SMS notifications
  • Skipping validation

    • ScheduleOnce will check if both the Name and Email fields were populated using the information provided in the URL.
    • ScheduleOnce will check if the Email value is a valid email format. If it isn't, the Booking form will be displayed, pre-populated, and show an email format error message.
    • If these validations don't pass, the Booking form will still be displayed with the relevant fields pre-populated. Note that no error messages will appear on the screen except for the Email validation message mentioned previously.
  • Email confirmation field

    • The Email confirmation field will not be displayed, when the Booking form is skipped or pre-populated.
    • The Email confirmation field will not be displayed, when the Booking form was meant to be skipped, but is displayed and pre-populated, due to missing required fields.
    • Showing or hiding the Email confirmation field is set in the Booking forms editor.
  • Subject field

    • It is highly recommended that you customize the Subject field, and not have it set by the Customer or use the defaults provided.
    • If the Skip flag is on and the Subject field is not populated but both the Name and Email fields are, the Booking form will skip and populate the Subject field with a default value:
      • Booking with approval: Personal meeting
      • Single session with automatic booking: Personal meeting
      • Session packages{# of sessions} sessions scheduled

URL character encoding

It’s important to understand that URLs can only be sent over the Internet using the ASCII character-set. Since URLs often contain characters outside the ASCII set, the URL has to be converted into a valid ASCII format. URL encoding replaces unsafe ASCII characters with a "%" followed by two hexadecimal digits. URLs cannot contain spaces. URL encoding normally replaces a space with a plus (+) sign or with %20.

A detailed explanation on URL encoding including a tool for encoding any text can be found at W3SCHOOL.

Related articles:

Rate this article