Version:
Only show these results:

Nylas-hosted Scheduling Pages

Nylas lets you host Scheduling Pages under the book.nylas.com sub-domain, so you can implement link-based scheduling in your Nylas application.

Create a hosted Scheduling Page

When you create a public Configuration with a URL slug, Nylas automatically hosts the Scheduling Page at https://book.nylas.com/<REGION>/<NYLAS_CLIENT_ID>/<SLUG>. The <REGION> represents the data center where your Nylas application is hosted (us or eu). The <SLUG> must be unique to the specified client ID.

Pre-fill a booking form

When you direct users to a hosted Scheduling Page, you can pass the following query parameters in the URL to pre-fill the booking form:

  • name: The guest's name.
  • email: The guest's email address.
  • Any keys in additional_fields that you defined in your Configuration.

For example, the following URL pre-fills the guest's name, email, and an additional field (patient_id) in the booking form:

https://book.nylas.com/us/<NYLAS_CLIENT_ID>/meet-nylas/?name=Leyah&email=leyah@example.com&patient_id=a1234

The guest still needs to fill out any other fields defined in the Configuration, and confirm the booking.

Query parameters persist on rescheduling, cancellation, and booking confirmation pages.

Make pre-filled fields read-only

You can add __readonly to any query parameter in your hosted Scheduling Page URL to make a pre-filled field read-only. For example, the following URL pre-fills the user's name, email, and patient_id, and makes the name and patient_id read-only fields.

https://book.nylas.com/us/<NYLAS_CLIENT_ID>/meet-nylas/?name__readonly=Leyah&email=leyah@example.com&patient_id__readonly=a1234