1. Feature Overview
LeadSquared Portals enable you to build your own customized online portals (for education/insurance/medical applications, course registrations, etc.) to capture leads and opportunities. This article shows you how to build a portal using the Upload Code option.
To learn how to build a portal without writing any code, see LeadSquared Portal Designer.
2. Prerequisites
- You must be the administrator of your LeadSquared account.
- You must have a Portal’s license.
- Forms and Processes, along with portals, must be enabled on your LeadSquared account.
- You must have developer experience.
3. How It Works
Portals are a collection of web pages used to complete an application or registration process. Most portals have –
- A log-in/log-out functionality where end users can generate credentials (usernames, passwords, etc), and use them to progress along the application process. These functionalities can be built using LeadSquared Portal API.
- The actual application forms which capture the end-users information, and the process or sequence of forms for more complex applications. These functionalities can be built using LeadSquared Forms and Processes. Also, see Process Designer.
Once the forms and processes are created, you can export them as HTML files and embed them into your portal.
All forms that are part of the process will be embedded into your webpage(s) along with the process logic. You don’t need to embed any forms separately.
- In your LeadSquared account, on the main menu, navigate to Workflow>Process Designer.
- Click Create Process, then click At Specific Work Area.
- On the pop-up, under Available Work Areas, click Customer Portal, then select the checkbox under Web.
- Click Save when you’re done.
Note: You can also edit an existing process and perform steps 3 and 4.
Now continue to build your process and publish it (for more information, see How to Create a Process). Edit the process in live edit mode, and click the code snippet 
icon on the top left side of the page (alongside the process name) –
Copy the process HTML and paste it in your webpage based on your customization requirements.
Once completed, you can upload the portal on LeadSquared (in Zip format) where you’ll be able to test it on a staging environment before hosting it on the live environment.
4. Create the Portal
- From the LeadSquared dashboard, navigate to Workflow>Manage Portals.
- Click the Create Portal button.
- Provide a relevant name for the portal, and add a description if required. Once you are done, click Create.
- On the Portal page, under Getting Started, click Upload Code.
- On the Upload Portal Zip pop-up, name the version of the zip file you are uploading.
- You can either drag and drop the zip code file, or upload it by clicking Select File. You will have to keep the following points in mind while uploading a zip file –
- Portals can be deployed to Test Environments by uploading a Portal Build File, as a compressed zip file.
- The Portal Build File can be any build file of a static website which can be hosted and deployed within LeadSquared. While React is recommended, Portals support other web frameworks as well. The max allowed upload size for the zip file is 10 MB. If you have complex use cases which requires a larger zip file size, you can reach out to support@leadsquared.com or your customer success manager.
- LeadSquared checks for the index.html file in the root of the uploaded zip file to understand the structure, runtime logic and other information about your website. Besides requiring the index.html file to be in the root of the Portal Build File, LeadSquared puts no other restrictions on the directory structure of your website.
- Once you have successfully uploaded the file, mention points that might be important to you or your team, under Notes.
- Once you’re done, click Deploy to Test.
5. Test the Portal
You can test the portal by first deploying it on the Test Environment. Once it is successfully tested, you can make it live.
- After you’ve created the portal and deployed it to the test environment, the HTML file you’ve provided is automatically uploaded to the Test Environment.
- For a couple of minutes, the Test Environment status will stay
red. - The status will automatically turn
green. If it doesn’t, click on the 
refresh icon. - If your portal is enabled in the live environment, you can click Publish to Live.
6. Configure the Portal
On the Portal page, navigate to Overview>Finishing Up>Settings, or click the Settings tab to Configure the portal. Here, you can configure the name, domain, email and SMS settings for the portal.
6.1 General Settings
Provide the name and description of the portal. This will help your users identify the portal. Once you’re done, click Save.
6.2 Domain Settings
Default Domain – You can host your portals on LeadSquared’s default domain.
- In the Domain Settings column, enter a subdomain name for the portal you’ve created.
- The URL for the default LeadSquared domain is “lsqportal.com”
- Once you have added the details, click Confirm.
To delete the portal, click Delete Portal.
Custom Domain – Alongside Use Custom Domain, enable the 
slider to host the portal on your own custom business/brand sub-domain (e.g., applications.mybusiness.com).
For details, see Use Custom Domains for Your Portals.
6.3 Email Settings
You can edit or disable email notifications a lead or opportunity would receive for “Signup”, “Forgot Password”, and “Password Reset”. To configure these emails –
- Navigate to Settings>Email Settings.
- Expand the email tab. You will find the Disable Email and Edit options.
- If you want to edit the email, click on the Edit button. This opens a window where you can edit the email.
- Once you’re done editing the mail, click Done.
- To send out a test mail, click Save and Test, and on the Test your email content pop-up, enter the mail Id to which you want to send the test mail.
- To disable these emails, click Disable Email, and confirm that same.
6.4 SMS Template Settings
To verify your lead’s mobile numbers (for Portal Registration and Portal Login), we send out OTPs via SMS. This is done by default, and it requires no additional configuration from your end. To include your company’s name in the default SMS, click Edit, and enter the name.
7. Version History
You can view the various versions of the code that was uploaded on this portal.
- Under Actions, click the
icon against any version of the code. - To test a previous version of the code, click Publish to Test.
- To download a previous version of the code, click Download Zip.
8. Releases
- You can check all the versions that have been uploaded to the portal under the Releases tab.
- The default selection is All Releases, but you can also filter by Test Releases and Live Releases.
Any Questions?
Did you find this article helpful? Please let us know any feedback you may have in the comments section below. We’d love to hear from you and help you out!
