Scheduler v2 booking flow query parameters
When you send users to a booking page, you can pass in your query parameters using the page URL and pre-populate input fields. The pre-filled information makes booking easier for users. This example contains information about the attendee.
https://schedule.nylas.com/my-page-slug?patient_id=Ax1233B The parameters are saved in the following places:
- Follow up emails
- Edit links
- Cancel links
- Thank you page
You can pre-fill the query parameters ?email and ?name if your application already knows the guest's identity. Guests are still asked to confirm the booking and provide any additional fields defined in the Scheduling Page configuration.
Custom Query Parameter Options
You can figure custom booking flow query parameters so that users can't edit values. This grays out the fields or field to prevent users from editing.
The prefilled_readonly=true parameter configures all form values as uneditable by the user.
For a specific query parameter to be read-only, add a copy of that specific query parameter with the appended _readonly=true option. The _readonly=true option configures the query parameter as read-only. In this case, both standard and custom fields can't be edited.
The example below shows the name value as read-only. The line breaks allow for visibility.
?name=albert&
name_readonly=true Working with HTML Elements
You can combine prefilled_readonly with iframe HTML elements to hide the URL bar and prevent users from modifying the values.
Booking Flow Query Parameters Examples
The examples below include sample Scheduling Page URLs. For all uneditable form values, the example uses prefilled_readonly=true. The specific uneditable form values example uses the _read_only option appended to custom_field_1 and custom_field_2. The line breaks separate the query parameters for visibility.
https://schedule.nylas.com/nylas-book-me/book/1615997400?
prefilled_readonly=true&
name=Albert&
email=al@example.com&
additional_guests=john@example.com&
custom_field_1=Hello&
custom_field_2=World` https://schedule.nylas.com/nylas-book-me/book/1615997400?
name=Albert&
email=al@example.com&
additional_guests=john@example.com&
custom_field_1=Hello&
custom_field_2=World&
custom_field_1_readonly=true&
custom_field_2_readonly=true`