These options, called Universal Resource Locator (URL) query parameters, are designed to help developers deep link directly to the part of the onboarding experience desired, helping facilitate signup and payment without as much coding as direct Application Programming Interface (API) calls from a server, or in some cases without coding at all.
- blankLandingPage=true
- When used in combination with bundleLink, this shows only the dialog, hiding the rest of the landing page. This is useful when to present only the intended product bundle instead of the carousel and the rest of the landing page.
- bundleLink=kebab-case-product-bundle-name
- Automatically and immediately selects a product from the landing page carousel and brings up its confirmation dialog. For example, to select Compounded Semaglutide from the carousel, use bundleLink=compounded-semaglutide
- email=test%40example.com
- Sets the email address of the patient, preventing them from accidentally using a different email in our system from the one you have in yours. The email should be URL encoded, so test@example.com would be test%40example.com. URL encoding is also known as percent encoding.
- inescapableFlow=true
- Prevents escape from the dialog sequence unless the browser back button is used. This is useful with the blankLandingPage=true option to prevent the user from exiting the dialog to an entirely blank screen.
- jumpToQuestionnaire=true
- Skips the first part of the dialog, jumping directly to the user qualification questions. This is useful to avoid redundancy when website the user comes from already gives the details of the product.
- Promo=Lose15
- Discounts the price during checkout without requiring the user to type it in. Note that Lose15 isn't a real code. Please use the code provided by our support personnel.
- phone=%2B12258675309
- Sets the phone number of the patient, preventing them from accidentally using a different phone number in our system from the one you have in yours. The phone number should be URL encoded, so the internationally formatted USA phone number +12258675309 would be %2B12258675309
- referralCode=ABC123
- Specifies a referral tracking code so the patient does not need to remember to type it in
- signupSuccessRedirectURL=https%3A%2F%2Fwww.google.com
- Allows sending the user to an arbitrary URL after signing up. The example shown is the URL encoded version of http://www.google.com, but any URL could be used, for example a confirmation page or thank you page.
- testMode=true
- Creates the patient's case without payment information and indicates to support personnel that the case isn't real
Here is an example that uses several of these URL options at once to focus on the questionnaire and signup for one product. It could even be embedded in an iframe as a signup form:
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article