Portal APIs in Zoho CRM - Part I
Welcome back to another week of Kaizen everyone!
This week, we will be discussing the Portals API in Zoho CRM.
What are Portals in Zoho CRM?
Portals in Zoho CRM allow businesses to extend access to their CRM to external stakeholders, such as customers, partners, vendors or franchisees. Portals allow users to view, edit and create records within the CRM, depending on their level of access and permissions. This helps businesses to manage customer and partner interactions, share information and improve communication.
Sample Business Cases:
In Health care Industry - If you run a health care facility, you can provide your patients the access to their medical records using portals. Through the portal, the patients can have controlled access to their medical records like their appointments, tests done and medication prescribed. Patients can request appointments, provide updates to their information, and request copies of their medical records through the portal.
In a consulting firm - If you run a consulting firm, you would want to keep your clients updated about the status of their projects in real time. To do this, you can create a portal and share it with your clients. The clients can view the status of their projects, including the progress, the budget, and the schedule. Clients can view the updates and provide feedback on the project through the portal.
In the automobile industry - If you have an automobile shop, and you want to track the customer details, your sold vehicle details and service schedules, you can create a portal and share it with your customers. They can view and update their details and book for services using through the portal.
Creating a Portal via API
Let us consider the context of the automobile industry. To create a portal for your customers, you can use the Create Portal API.
Request URL : {api-domain}/crm/v4/settings/portals
Request Method : POST
Scope : ZohoCRM.settings.clientportal.ALL/CREATE
Sample Input
{ "portals": [ { "name": "ZylkerAutomobiles" } ] } |
Input Keys
| Key | Description |
| name | Unique name of the portal. |
Sample Response
{ "portals": [ { "code": "SUCCESS", "details": { "name": "ZylkerAutomobiles" }, "message": "Portal created successfully with given name.", "status": "success" } ] } |
Update Portal via API
You can update the portal name via Update Portal API.
Request URL : {api-domain}/crm/v4/settings/portals/{portal-name}
Request Method : PUT
Scope : ZohoCRM.settings.clientportal.ALL/UPDATE
For instance, the following request renames the already created portal ZylkerAutomobiles to ZylkerAutos.
Sample Request : https://www.zohoapis.com/crm/v4/settings/portals/ZylkerAutomobiles
Sample Input
{ "portals": [ { "name": "ZylkerAutos" } ] } |
Input Keys
Key Description name Unique name of the portal.
| Key | Description |
| name | Unique name of the portal. |
However, changing the portal name will also alter the portal URL. As a result, it is crucial to communicate this change to all existing portal users.
Get Portals via API
At any point, if you want to get the details of all the portals configured in your CRM account, use the Get Portal API.
Request URL : {api-domain}/crm/v4/settings/portals
Request Method : GET
Scope: ZohoCRM.settings.clientportal.ALL/READ
Sample Response:
{ "portals": [ { "created_time": "2023-02-07T20:13:20+05:30", "modified_time": "2023-02-07T20:13:20+05:30", "modified_by": { "name": "Patricia Boyle", "id": "4876876000000327001" }, "name": "ZylkerAutos", "active": true, "zaid": "10052946888", "created_by": { "name": "Patricia Boyle", "id": "4875876000000327001" } } ] } |
Response Keys
| Key | Description |
| name | The name of the portal |
| active | Represents whether the portal is active or not. |
| zaid | The unique id of the portal. |
Now let us consider the case where you may want to extend the portal access to beyond your customers. There would be multiple user groups you may want to extend the access to, including the employees and partners. For instance, you may want to share the portal with your employees to give them access to customer information, sales data and service schedules. If you have partners, you may want to share the portal with them to keep them informed about the customer behaviors, sales data etc. Each of these groups may require to access to different types of data within the CRM.
To accommodate the different needs and access levels of the different types of users, you may need to create multiple user groups in the portal. For example, you could create a user group for customers and another user group for employees. The business can then configure different permissions for each user group, allowing or restricting access to the relevant data in the CRM account. This way, each type of user will be able to access the information that is most relevant to them, without compromising the security and privacy of the rest of the data in the CRM account.
Get Portal User Types API
The Get Portal User Types API allows you to retrieve the user types available in the portal of your org. It is important to note that when you create a portal, the default user type Client Portal is added by default.
Request URL : {api-domain}/crm/v4/settings/portals/{portal_name}/user_type
Request Method : GET
Scope: ZohoCRM.settings.clientportal.ALL/READ
Sample Request : https://www.zohoapis.com/crm/v4/settings/portals/ZylkerAutos/user_type
Sample Request : https://www.zohoapis.com/crm/v4/settings/portals/ZylkerAutos/user_type
Sample Response
{ "user_type": [ { "created_time": "2023-02-08T11:56:16+05:30", "default": true, "modified_time": "2023-02-08T11:56:16+05:30", "personality_module": { "plural_label": "Contacts", "api_name": "Contacts", "id": "1306462000000000129" }, "name": "Client Portal", "modified_by": { "name": "Patricia Boyle", "id": "1306462000083528405" }, "active": true, "id": "1306462000001813022", "created_by": { "name": "Patricia Boyle", "id": "1306462000083528405" }, "no_of_users": 1 } ] } |
Response Keys
| Key | Description |
| default | Represents whether the user type is the default one for the portal. |
| personality_module | Details of the module for which the user type was configured. |
| name | The name of the user type. |
| active | Represents whether the user type is active or not. |
| id | The unique id of the user type. |
| no_of_users | The number of users in the portal assigned with this user type. |
Invite users to Portal via API
Once the portal is created, you can invite the customers to join the portal using the Invite Users to Portal API. This provides the customers with access to the information regarding their automobile including the servicing details, and their information.
Request URL : {api-domain}/crm/v4/{personality_module}/{record_id}/actions/portal_invite
where, personality_module is the API name of the module for which the portal was created and record_id is the ID of the record that you want to invite to the portal
Request Method : POST
Scope: ZohoCRM.settings.clientportal.ALL/CREATE
Parameters
| Parameters | Parameter Description |
user_type_id : integer, mandatory | The id of the user type you want to assign the user with. |
type : string, mandatory | Represents whether the user is invited (invite) the first time or is re-invited(reinvite). |
language : string, optional | The language code of the user you want to invite to the portal |
Please note that for the client portal user type, you can invite only clients/customers and not users with the same email domain like your employees or partners.
Sample Request : https://www.zohoapis.com/crm/v4/Contacts/1306462000000659009/actions/portal_invite?user_type_id=1306462000001813022&type=invite&language=en_US
In this sample request, 1306462000000659009 is the record id of the customer in Contacts module, and 1306462000001813022 is the user type id.
Sample Response
{ "portal_invite": [ { "code": "SUCCESS", "details": { "record_id": "1306462000000659009" }, "message": "An Invite has been sent to the personality.", "status": "success" } ] } |
Get Users of a User Type API
The Get Users of a User Type API enables you to retrieve the list of users available in a specific user type of a portal.
Request URL : {api-domain}/crm/v4/settings/portals/{portal_name}/user_type/{user_type_id}/users
Request Method : GET
Scope : ZohoCRM.settings.clientportal.ALL/READ
Parameters
| Parameters | Parameter Description |
type : string, optional | The type of user. Possible values are AllUsers, AllActiveUsers, ActiveUsers, DeactiveUsers, NotConfirmedUsers, ConfirmedUsers, and ActiveConfirmedUsers. |
filter : JSON object, optional | To filter based on the value disabled on updation of email of the status_reason__s field in the Users module. The allowed comparators are equal and not_equal. Note that you must encode this JSON object. |
The following request retrieves the details of users in your ZylkerAutos portal, with Client Portal user type.
Sample Request : https://www.zohoapis.com/crm/v4/settings/portals/ZylkerAutos/user_type/1306462000001813022/users
Sample Response
{ "users": [ { "personality_id": "1306462000000659009", "confirm": true, "status_reason__s": null, "invited_time": "2023-02-08T18:03:10+05:30", "module": "Contacts", "name": "Jennifer Spears", "active": true, "email": "jennifer.spears@abc.com" } ], "info": { "per_page": 200, "total_count": 1, "count": 1, "page": 1, "more_records": false } } |
Response Keys
| Key | Description |
| personality_id | The id of the module for which the portal was created. |
| confirm | Represents whether the user is a confirmed user or not. |
| status_reason__s | The reason the user is disabled. |
| module | The API name of the module for which the user type was created. |
| name | The full name of the contact. |
| active | Represents whether the user type is active or not. |
| The email ID of the contact of that user type. |
We will discuss more on user types and users in next week's post. We hope you found this post useful.
Write to us at support@zohocrm.com if you have any questions.
Previous Kaizen Post : Client Script ZDKs for Detail (Canvas)
Access your files securely from anywhere
New to Zoho Recruit?
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Bigin?
Topic Participants
Anu Abraham
Sticky Posts
Kaizen #197: Frequently Asked Questions on GraphQL APIs
🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.Kaizen #198: Using Client Script for Custom Validation in Blueprint
Nearing 200th Kaizen Post – 1 More to the Big Two-Oh-Oh! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.Celebrating 200 posts of Kaizen! Share your ideas for the milestone post
Hello Developers, We launched the Kaizen series in 2019 to share helpful content to support your Zoho CRM development journey. Staying true to its spirit—Kaizen Series: Continuous Improvement for Developer Experience—we've shared everything from FAQsKaizen #193: Creating different fields in Zoho CRM through API
🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.Client Script | Update - Introducing Commands in Client Script!
Have you ever wished you could trigger Client Script from contexts other than just the supported pages and events? Have you ever wanted to leverage the advantage of Client Script at your finger tip? Discover the power of Client Script - Commands! Commands
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho CRM Resources
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
Feature announcement - Simplifying document creation with Zoho Sign
Hi there, We are pleased to announce the release of our document creation feature, enabling you to create, edit, and finalize documents like agreements, purchase orders, and contracts without relying on external tools or applications. <br> ThisIntegrating File Attachments in Zoho Flow Email Notifications
Hi, I would like to be able to send an email once an entry is made in a form, and in this email, I would like to attach a file that has been added to the form using the ImageUpload (or FileUpload) widget. So, I started by creating a flow that will triggerCRM->INVENTORY, sync products as composite items
We have a product team working in the CRM, as it’s more convenient than using Books or Inventory—especially with features like Blueprints being available. Once a product reaches a certain stage, it needs to become visible in Inventory. To achieve this,Zoho Mail SMTP IP addresses
We are using Zoho Mail and needs to whitelist IP for some redirections from your service to another e-mails. You can provide IP address list for Zohomail SMTP servers?Zoho project purchases
Hi Folks, I think having a purchase module in projects will help in putting together a project p and L. Project wise purchases and expenses. Do let me know your thoughts.Create Tasklist with Tasklist Template using API v3
In the old API, we could mention the parameter 'task_template_id' when creating a tasklist via API to apply a tasklist template: https://www.zoho.com/projects/help/rest-api/tasklists-api.html#create-tasklist In API v3 there does not seem to be a way toHow can I restore all the deleted Time entries of a Task in Zoho Projects
How can I restore all the deleted Time entries of a Task in Zoho Projects? Query: In Zoho Projects, I cloned a task and deleted the time entries from the cloned task. However, this also deleted the time entries from the original task. How can I restoreIs there a way to make an account inactive in ZoHo Desk
We have a few Clients "Accounts" that we no longer do business with. It would be beneficial for them to not show up in lists. However, we want to go back and view tickets, time, etc.How to set the value of the Phone field importing contacts in Zoho Desk
Hi everyone, i'm new in Zoho Desk, we're setting up the environment and i'm importing contacts from another CRM using a file CSV and i'm getting a problem with phone numbers (italian): the leading zero is cut away, also if the value is inside double quotes.Can we generate APK and IOS app?
Dears, I want to know the availability to develop the app on zoho and after that .. generate the APK or IOS app and after that I added them to play store or IOS store.. Is it possible to do this .. I want not to use zoho app or let my customers use it. thanksSet Custom Icon for Custom Modules in new Zoho CRM UI
Change total display format in weekly time logs
Hi! Would it be possible to display the total of the value entered in the weekly time log in the same format that the user input? This could be an option in the general settings -> display daily timesheet total in XX.XX format or XX:XX.Deprecation Notice: OpenAI Assistants API will be shut down on August 26, 2026
I recieved this email from openAI what does it means for us that are using the integration and what should we do? Earlier this year, we shared our plan to deprecate the Assistants API once the Responses API reached feature parity. With the launch of Conversations,How to center a field inside a section?
I’ve been trying to center a field inside a section in Zoho Canvas. When I align it visually, it looks centered in the editor, but after clicking Save, the field appears misaligned on the actual canvas. I also tried setting the field to full width, butQuick Create needs Client Script support
As per the title. We need client scripts to apply at a Quick Create level. We enforce logic on the form to ensure data quality, automate field values, etc. However, all this is lost when a user attempts a "Quick Create". It is disappointing because, fromKaizen #192 - Implementing Custom Token Persistence in Python SDK
Welcome back to another week of Kaizen! Last week, we discussed how to implement Login with Zoho using OAuth 2.0 and saw how to bring it to life in a real-world application with the Zoho CRM Python SDK. We also discussed how Zylker Academy built a customShowing the map along with mileage expense
When you use the GPS to track mileage, it shows you the map of the actual path travelled. It would be very useful and practical to save that map with the mileage expense, so that when the report is created, it provides a map of each mileage expense associatedIs there any way to recall an email sent using Zoho CRM?
If an email is sent using Zoho Mail, there is a recall option/functionality that is available to the sender. Is there any way to recall an email if it was sent using Zoho CRM? I can't seem to find that option. Any help would be appreciated.Enable Validation Rule for Multi-Select Picklist Field
Zoho, Please allow validation rules for multi-select fields.File Upload field not showing in workflow
Hi, I have added a field on Zoho CRM. I want to use it in a workflow where that particular field is updated based on another field, however it is not showing up in the field list to select it in the workflow. Why is this please?CRM Custom function updating a module record shows the Super Admin user as the record modifier
Dear Zoho CRM Team, Is there any way to update this so that when a custom function has updated a record the Super Admin user doesn't become the modifier? This happens on the record as a modifier and shows up in the audit logs. It would be more usefulBest practice importing items and matching assemblies
Hi, I was wondering what would be the best practice to import items and composite items (assemblies) From my backup, what should I import first? The items or the composite items? I am on Zoho one, using inventory and books. Kind regards, SabineBest way to fetch employee names from Zoho People into Zoho Creator Inventory Stock Form field Employee Name Lookup
Hi Team, I have a requirement in my Zoho Creator application (Inventory Stock Adjustment) where I need to fetch employee names from Zoho People and use them as a lookup in a form. Currently, I am considering using an integration field to fetch this dataget file api is returning Junk data
I am working on extension development where at one point I need to retrieve attachments on records I found out I can use only invokeconnection and not invokeurl in extension development The invoke connection returns the image in raw binary format. WhenNeed help with message box
End user updates many records at once. Each have unique serial number. They want a confirmation box that says starting number, ending number and qty. Is there any way to do this? I been searching and asking support but seems like no great solution.[Webinar] The Transformative Power of Gen BI
Traditional decision-making tools are no longer enough. The integration of generative AI into business intelligence (BI) is proving to be a true game changer—enabling businesses to make faster, smarter, and better informed decisions. Early adopters ofBackorder process review - Automating Removal of Sales Order from "On Hold" When PO is Received
Hello Zoho Inventory Team, Currently, sales orders in On Hold status are released only when the bill for the purchase order is created. In our workflow, it would be much more efficient if the sales order could automatically move out of On Hold as soonHow to access the saved Query using API?
I have created a query in setting. Is it possible to access it from a API? What's the endpoint? I tried /v8/queries/important_deals but didnt' work.création d'une base de données
base de donnee d'un lycéeUser Session variables to recall after form submit & redirect to menu
Hey, Forgive me if this is a simple answer I have overlooked. I have built a big onboarding process for my SAAS platform which is built and managed by an external Dev team. I am hoping to embed my new creator app on the SAAS platform. I have a menu pageZoho Writer Merge Template with data from Zoho Analytics Views
Hello, Is there any way to pull information from Zoho Analytics and put it into a Merge Template? I am trying to create a bulk export of one report that filters on a field to create a single document for each of the filter fields.Having to enter bill before stock shows as available.
Hi, Am I right in thinking you must create a bill from the purchase order receipt before the goods are available for shipping?Agent Availability report
From data to decisions: A deep dive into ticketing system reports Businesses need to track when their support agents check in and check out from work. This report, titled Agent Availability, is one of the static reports that helps managers track the numberWriting by Hand in "Write" Notes
Hi there! I just downloaded this app a few moments ago, and I was wondering if there was a way to write things by hand in "Write" mode instead of just typing in the keyboard. It would make things a bit more efficient for me in this moment. Thanks!Project Management Bulletin: August, 2025
We’ve touched a grand 19 years since we started pioneering project management solutions with Zoho Projects. What started as a simple one-page interface is now a suite of products with Zoho BugTracker, Zoho Sprints, and our new debut Zoho Projects Plus,AI-driven construction analytics using Zoho Projects Plus
Construction projects thrive on timelines; if a project is completed on or before the expected time, it makes headlines, but if it gets delayed, the company’s credibility will be at risk. Such projects require precise planning and constant monitoring,Canadian payroll
Hello ZOHO, is any updates on when payroll for Canada will be available?Unified customer view: Bringing product intelligence into your CRM data
For businesses today, applications and digital interfaces are the main touch points in the customer journey. While Zoho CRM data already tells who your customers are and what they buy, Zoho Apptics tells you how they interact and engage with your product.Zoho Creator SaaS app with multiple client AND multiple users
I am close to finalizing a Zoho Creator app that will be used by different companies to manage sale info, and each company can have multiple users using the app. Things were going perfectly until I tried a search on a report. I use a database field in each table to separate the data for each company, which works great. BUT when I do a search, I get to see ALL the data. This means that Company A could easily see the data from Companies B and C via the built-in search. Is there a way to set up theProject Change Orders and Additions
We are in the process of migrating from QuickBooks Online to Zoho Books. We have Zoho One and like the ability to sync all of our data across everything. And I like that projects work in a way that's less dumb than QuickBooks. I'm trying to figure outNext Page