Kaizen #72 - Portal #APIs [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
Centralize Knowledge. Transform Learning.
All-in-one knowledge management and training platform for your employees and customers.
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 #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.Kaizen #226: Using ZRC in Client Script
Hello everyone! Welcome to another week of Kaizen. In today's post, lets see what is ZRC (Zoho Request Client) and how we can use ZRC methods in Client Script to get inputs from a Salesperson and update the Lead status with a single button click. In thisKaizen #222 - Client Script Support for Notes Related List
Hello everyone! Welcome to another week of Kaizen. The final Kaizen post of the year 2025 is here! With the new Client Script support for the Notes Related List, you can validate, enrich, and manage notes across modules. In this post, we’ll explore howKaizen #217 - Actions APIs : Tasks
Welcome to another week of Kaizen! In last week's post we discussed Email Notifications APIs which act as the link between your Workflow automations and you. We have discussed how Zylker Cloud Services uses Email Notifications API in their custom dashboard.Kaizen #216 - Actions APIs : Email Notifications
Welcome to another week of Kaizen! For the last three weeks, we have been discussing Zylker's workflows. We successfully updated a dormant workflow, built a new one from the ground up and more. But our work is not finished—these automated processes are
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
Applying Excess Payments & Conflict Invoices Due to Cancelled Items
I’m running into several issues that appear to stem from deeper-than-expected overlap between Zoho Finance (Books/Inventory) and Zoho POS. The level of coupling between these systems seems greater than what was originally communicated, and it’s leadingZoho Sprint Backlog View, filter by item status
Hello, In Zoho Sprints, it would be great to be able filter out specific items in the Backlog based on their status. We would like to track items that were Removed from our backlog without seeing them constantly in the Backlog view, as this view shouldWATERFALL CHART IN ZOHO ANALYTICS
Hi Team, I would like to know whether Zoho Analytics currently supports a Waterfall Chart as a built-in visualization type. If yes, could you please share the steps to create one? If not, is there any workaround or recommended method to build a WaterfallExport contacts from Bigin's mobile app to your Android device
Hello everyone! We're happy to announce that you can now export customer contacts from the Bigin mobile app to your device. Scenario A small-scale business owner has two pipelines in Bigin—one for procuring raw materials and the other for selling hisPassing Info from Function to Client Script
Hello, I have recently started making use of client script for buttons, allowing me to give the user information or warnings before they proceed. This is great. However, I have never quite managed to pass back any extra information from the function toASAP iOS SDK – Xcode Compatibility Update
Hello everyone, We have been delivering the ASAP iOS SDK developed using Xcode 16.1 to provide Help Center support within mobile applications. Thus, ASAP iOS SDK versions upto 4.5.8 are compatible with development environments running in Xcode 16.1 andSub form auto field population based on parent form
I have a parent form called "Sites" with a text field called "Site". I have a subform called "Design Comments" (actual form name "Review Comments") with a lookup field name "Sites1" that looks up from the Sites form. I want the Sites1 lookup field toA note-taking app right inside your project management space
How do you feel when you check off the last task from your to-do list after a long day at work? Euphoric, blissful, satisfied? Now, imagine completing the same checklist from your PM platform, without juggling tools. Sounds simple and handy? That’s exactlyEmail Forwarding: Maintain business continuity
As an administrator, ensuring uninterrupted email communication is critical when a role-based employee is unavailable due to extended leave or a temporary role change. Emails from customers, partners, and internal teams must continue to be received andTip #61- Collaborate live with Invite Technician- 'Insider Insights'
We’ve all been there: you’re deep into a complex remote session, and you realize you need a second pair of eyes. Instead of ending the call or rescheduling, why not just bring the expert to you? With Zoho Assist, you can invite internal colleagues orHow to integrate Zoho CRM, Zoho Forms and a WIX Web Site
Attached video demonstrates how to use Zoho Forms included in Zoho One, to design a Contact Us form to be embedded into a WIX web site and integrated into Zoho CRM.Bug Causing Major Sync & SO Access Failures in Zoho POS
We are experiencing critical and recurring issues in Zoho POS that all trace back to role-permission handling defects in the latest POS app version. These issues directly affect syncing, login ability, and Sales Order access for role-restricted usersChange Last Name to not required in Leads
I would like to upload 500 target companies as leads but I don't yet have contact people for them. Can you enable the option for me to turn this requirement off to need a Second Name? Moderation update (10-Jun-23): As we explore potential solutions forOAuth2 Scope Error - Incorrectly defaulting to CRM instead of Analytics.
Hello Zoho Team, I am trying to connect n8n to Zoho Analytics API V2 for a simple automation project. Despite using the correct Analytics-specific scopes, my OAuth handshake is failing with a CRM-related error. The Problem: The authorization screen shows:Add Custom Reports To Dashboard or Home Tab
Hi there, I think it would be great to be able to add our custom reports to the Home Tab or Dashboards. Thanks! Chad Announcement: The feature is being rolled out across DC's and Edition in phases. To know more refer to the announcement post here.Hiding Pre-defined Views
You can enhance Zoho with custom views - but you cannot hide the pre-defined views. Most users focus on 4 or 5 views. Right now for EVERY user EVERY time they want to move to one of their 4 or 5 views - they have to scroll down past a long list of pre-definedwhy can't agent see accounts & contacts
My new user, with 'Agent' privileges, cannot see records that don't belong to them. How can I give them access? Why isn't this the default configuration in Zoho?Sender Email Configuration Error.
Hello Team, Hope you are all doing well. We are in the process of creating the Zoho FSM environment in the UAE. When we try to add the sender email address “techsupportuae@stryker.com”, we receive the error message: “Error occurred while sending mail【Zoho CRM】フィルター機能のアップデート：ルックアップ項目を使ったデータフィルタリング
ユーザーの皆さま、こんにちは。コミュニティチームの藤澤です。 今回は「Zoho CRM アップデート情報」の中からフィルター機能のアップデートをご紹介します。 ルックアップ項目を使ったデータフィルタリングがより詳細に行えるようになりました。 この機能は詳細フィルターとカスタムビューで利用でき、必要な情報を正確に取得できます。 これにより、タブ間を移動することなく、より深く正確な方法でデータを絞り込むことが可能になります。 ◉できること 詳細フィルターとカスタムビューで、ルックアップ先タブの項目が選択可能This will be long, Please bear with me - Next Gen Layout - Search
In general, I think that Zoho are going in the right direction with the Next Gen UI. The latest update brings some nice improvements and all-in-all from a user's perspective I think the improvements are generally very good. However, there are some areasZoho Books | Product updates | July 2025
Hello users, We’ve rolled out new features and enhancements in Zoho Books. From plan-based trials to the option to mark PDF templates as inactive, explore the updates designed to enhance your bookkeeping experience. Introducing Plan Based Trials in ZohoZoho Books | Product updates | August 2025
Hello users, We’ve rolled out new features and enhancements in Zoho Books. From the right sidebar where you can manage all your widgets, to integrating Zoho Payments feeds in Zoho Books, explore the updates designed to enhance your bookkeeping experience.Quotes Approval
Hey all, Could you please help in the following: When creating quotes, how to configure it in a way, that its approval would work according to the quoted items description, not according to quote information. In my case, the quote should be sent to approvalImportant Update: Facebook Pages API Deprecation
Dear Zoho Analytics users, As of January 26, 2026, Facebook has officially deprecated Facebook Pages API version 18. This update involves the removal of several metrics that were previously supported by the API. As a result, these changes will affectAdding a Deal to and Existing Contact
I want to easily add a Deal to an existing Contact. If I click on New Deal on the Contact page this currently this is what happens: All of the mandatory field (and other field) information exists within the Contact. Is there a simple way for it to automaticallyCustom SMTP is now available in Zoho Sign
Hi there! Want to send Zoho Sign emails from your organization's or personal email server? Look no further! Zoho Sign has introduced custom Simple Mail Transfer Protocol (SMTP) for Enterprise users across all data centers. By enabling custom SMTP, youEmail was sent out without our permission
Hi there, One customer just reached out to us about this email that we were not aware was being sent to our customers. Can you please check on your end?Flexible Partial-Use Coupons (Stored Value Credits)
Subject: Feature Request: Ability for users to apply partial coupon balances per transaction Problem Statement Currently, our coupons are "one-and-done." If a user has a $50 coupon but only spends $30, they either lose the remaining $20 or are forcedPrevent accidental duplicate entry of Customer Ordersome
Zoho Support has confirmed that Zoho currently does not have any method (using Deluge, flow or any other method) to alert a user when a sales order has been entered twice using the same customer reference number (i.e. a duplicate). Most ERP platformsMigrating Brevo Automation Logic to Zoho Campaigns
Hello Zoho Campaigns Support Team, I am in the process of migrating my email marketing from Brevo to Zoho Campaigns. I have around 10,000 contacts, which I have already successfully exported from Brevo and imported into Zoho Campaigns. I now need guidanceIs there a way to delete workspaces?
I want to remove one of the workspaces in my Campaigns account. I don't see any obvious way to do this. Am I missing something?Collapsing and expanding of lists and paragraphs
hello Would you ever implement Collapsing and expanding of lists and paragraphs in zoho writer ? Best regardsNew Custom View -Sorting the Custom fields
While creating a New Custom View in invoice , Customers, Bills ,expense etc , the sorting of custom fields are not available , a query function "order by / sort by " may also be included in Define new criteria module which will be more beneficial toMake CAMPAIGNS email look as simple as possible
Hi there I'm trying to make my Campaigns email look as much like a normal email as possible. I'm a bit stuck with the "justification" of the email email block. Can I LEFT JUSTIFY the "whole email" to make it look "normal"? (Please see screenshot attached)[Webinar] Top 10 Most Used Zoho Analytics Features in 2025
Zoho Analytics has evolved significantly over the past year. Discover the most widely adopted features in Zoho Analytics in 2025, based on real customer usage patterns, best practices, and high-impact use cases. Learn how leading teams are turning dataSorry! we encountered some problems while sending your campaign. It will be sent automatically once we are ready. We apologize for the delay caused.
Hello. Lately we are having problems with some campaigns, which show us this error message. Sorry! we encountered some problems while sending your campaign. It will be sent automatically once we are ready. We apologize for the delay caused. We can't findCan I remove or divert certain contacts from an active Campaigns workflow?
I have created a workflow in Zoho Campaigns, which sends different emails, once contacts have been added to a mailing list. To choose which email to send to the contacts, there are conditions, which divert contacts based on their company type and their company size. There was a subsection of this workflow, where company size wasn't selected correctly, and some contacts have been sent down the wrong path and received the wrong email. The workflow contains a reminder loop and a further series of emails.How to map fields from Zoho Recruit to Zoho People
I've got these fields from my Job Offer that I'm trying to map to the Work information fields in Zoho People, but they arent showing up. For example, how do I get the department name field (in the job post) to map to the work information field in ZohoUTM in zoho campaigns
Helloo everybody!!! Someone know how IF ZOHO CAMPAIGNS has UTM for tracking the url of any campaigns. thank uFull Context of Zoho CRM Records for Zia in Zoho Desk for efficient AI Usage
Hello everyone, I have a question regarding the use of Zia in Zoho Desk in combination with CRM data. Is it possible to automatically feed the complete context of a CRM record into Zia, so that it can generate automated and highly accurate responses forNext Page