You can pre-fill the Coconut Client View with specific values—such as location, service, or staff—by adding URL parameters to your booking link. This helps you:
Launch directly into a specific branch from your website or online banking
Pre-select a service category like Personal or Business banking
Pre-select a specific staff member or meeting method
This article explains which parameters are supported, how they work, and how to construct valid URLs.
URL Parameters vs. Booking Shortcuts
Coconut supports two different ways to pre-configure the booking page:
Booking Shortcuts (links that use
/s/yourShortcutName)URL parameters (e.g.,
?location=e:1234&category=personal)
Note:
You must choose one approach per link. Coconut does not support combining a booking shortcut path and URL parameters in the same URL (for example, .../s/PersonalBanking?location=e:1234). If you need to use URL parameters, start from the standard client view URL, not a /s/... shortcut.
When to Use URL Parameters
You want to build links dynamically from your own systems (e.g., website, online banking, Google Maps, etc.)
You want to preselect location, staff, service, category, or meeting method using IDs or external identifiers
You don’t want to maintain a large number of individual booking shortcuts
Requirements
Before you start:
You must know the base client view URL for your instance, for example:
or a branded domain such as
https://appointments.yourbank.com/service
You must have the IDs or external IDs for the resources you want to pre-fill:
Locations
Staff
Services
Categories
Meeting methods
Finding IDs in Coconut
Location IDs
Go to Locations
Click the three vertical dots next to the location of your choosing
Click Edit
In your browser address bar, look for the URL like
.../locations/1234512345is the Location ID.To locate a location's external ID on the same page, scroll down to Preferences to see the External ID field.
In this example,
4533is the external ID.
Staff IDs
Go to Staff
Click the three vertical dots next to the staff member of your choosing
Click Edit
In the address bar, look for
.../staff/10060411006041is the Staff ID.
Service IDs
Go to Services
Click More → Edit beside the service.
In the Service popup, scroll down to see the External ID field
In this example,
homelineofcreditis the external ID
Category IDs
Go to Settings → Categories
Click the three vertical dots next to the staff member of your choosing
Click Edit
In the address bar, look for
.../categories/23122312is the Category ID.
Meeting Method IDs
If you need the numeric meeting_method IDs:
Use your existing analytics/API access or Coconut Support to look them up for your vendor, or
Prefer external IDs or slugs in URL parameters (for example,
meeting_method=e:video) and only use numeric IDs when specifically required.
Supported URL Parameters
The following parameters are supported in Client View:
location– Prefills a location (branch).staff– Prefills a staff member.service– Prefills a service (e.g., “Mortgage Appointment”).category– Prefills a service category (e.g., “personal”, “business”).meeting_method– Prefills a meeting method (e.g., in-branch, phone, video).
Each parameter accepts one of the following value types:
Coconut ID (numeric)
The internal ID for that resource.
Example:
service=508035
External ID (with
e:prefix)Your own external identifier for a resource, if configured in Coconut.
Example:
location=e:1026(where1026is your external branch/location ID)
Slug (string)
A URL-friendly string configured for that resource (most commonly for categories).
Example:
category=personal
URL Structure
A Client View URL with parameters follows standard URL rules:
Start parameters with a question mark
?Separate multiple parameters with an ampersand
&
Pattern:
or, if your Client View path includes /service or another route:
Examples
Prefill a location by external ID
Goal: Open the booking page with a specific branch already selected.
location– Tells Coconut to prefill the location.e:1026– Uses the external ID1026for that location
Prefill service category and location
Goal: Open the booking page with Personal Banking and a specific branch preselected.
category=personal– Uses the category slugpersonal.location=e:1026– Uses the external location ID.
Prefill service, staff, and location
Goal: Open the booking page with a specific service, specific advisor, and specific branch.
service=508035– Service with Coconut ID508035.staff=e:andreadvisor– Staff member identified by external IDandreadvisor.location=e:8102– Location identified by external ID8102.
Prefill meeting method
Goal: Open the booking page with Video (or another method) preselected.
The value accepted here depends on your configuration (ID, external ID, or slug). Your implementation team can confirm the correct values.
Best Practices
Do not combine booking shortcuts with URL parameters:
Avoid URLs like
.../s/PersonalBanking?location=e:1026.Instead, choose:
A booking shortcut only (e.g.,
.../s/PersonalBanking1026), orA pure URL-parameter link (e.g.,
.../service?category=personal&location=e:1026).
Standardize your patterns:
Decide on a consistent pattern for building links (for example, always using external IDs with the
e:prefix).Document that pattern for your web and online banking teams.
Test in lower environments first:
Validate that each parameter correctly pre-populates the booking page.
Confirm behaviour when users refresh the page or navigate back from a browser history action.
Troubleshooting
If the booking page does not look as expected:
Check the base URL
Make sure you are starting from the Client View URL, not a booking shortcut URL.
Validate parameter names
Ensure you are using the supported names exactly:
location, staff, service, category, meeting_method.
Validate parameter values
Confirm that:
Numeric IDs are valid resource IDs in Coconut.
External IDs exist and are correctly prefixed with e:.
Slugs (like
personal) match what is configured for that resource.
Test each parameter individually
Start with one parameter (for example, just
location).Add additional parameters one at a time to isolate any configuration issues.
Confirm configuration in Coconut
Ensure the location, services, staff, and meeting methods:
Are active
Are assigned correctly (e.g., to the right locations and categories)
Are bookable in the environment you’re testing
If you’ve validated the URL format and resource configuration and are still not seeing the expected behaviour, share the following with Coconut Support so we can investigate further:
The full URL you are using (with sensitive data removed if needed)
The IDs or external IDs you expect to be pre-filled
Screenshots of what you are seeing on the Client View