Kaizen #73 - Portal #APIs [Part II]
Hi everyone! Welcome back to another week of Kaizen!
In continuation to our previous post on Portal APIs in Zoho CRM, we will discuss more on user groups and users this week.
Let us consider the case of the automobile industry. In such a case, you may need to give portal access to more than one user type, such as customers, employees, and partners.
With user types, each user will have access to the information that is most relevant to their role. For example, when you give your customers portal access, they can book services, view and update their service schedules. Your partners or employees with portal access can view customer behaviours, sales date, etc.
Create a User Type via API
Using this API, you can create a user type for a portal you have already created.
Request URL: {api-domain}/crm/v4/settings/portals/<portal_name>/user_type
Request Method: POST
Scope: ZohoCRM.settings.clientportal.ALL/CREATE
Input Keys
Key | Description |
name : string, mandatory | Name of the user type. |
personality_module : string, mandatory | The module api name for which the user type is to be configured. |
active : Boolean, optional | Represents whether the user type is active or inactive. The default value is false. |
modules : JSONArray, mandatory | The JSON array containing keys that describe the user type's settings for different modules that are linked to the personality module through look up or multi-lookup fields. |
modules.layouts.id : Number, mandatory | The layout the user type should be able to access. |
modules.permission : key value pairs, mandatory | Boolean key-value pairs that represent the permissions you want the users to have in the module. The possible keys are view, edit, create. |
modules.views : JSONObject, mandatory | The custom view or canvas view to display the records for the user type. |
modules.id: Number, mandatory | The related module id. |
modules.shared_type : String, mandatory | Represents whether the module is a private or public module. |
modules.filters : JSONObject,mandatory | Field id, by which the module record can be filtered for the user type. |
modules.fields : JSONArray, mandatory | Field permissions for the user type with read_only (Boolean), api_name(field API name) and id of the each field to be configured for the module. Note that if any of the fields in the layout is marked mandatory, they cannot be read-only in the portal. |
For example, the following request creates the user type Customer for the ZylkerAutos portal, with view permission to the service module.
Sample Request:
Sample Input:
{ "user_type":[ { "name":"Customer", "personality_module":{ "api_name":"Customer" }, "active":true, "modules":[ { "layouts":[ { "id":"1306462000000095055" } ], "permissions":{ "view" : true }, "views":{ "id":"1306462000000091501", "type":"custom_view" }, "filters": null, fields": [ { "id": "18936550000000063924", "read_only": false } ], "id":"1306462000000000125", "shared_type":"private" }, { "layouts": null, "views": null, "filters": null, "permissions":{ "view":true }, "id":"1306462000000000147", "shared_type":"private" } ] } ] } |
Sample Response
{ "user_type": [ { "code": "SUCCESS", "details": { "id": "1306462000001856005" }, "message": "user type created successfully.", "status": "success" } ] } |
Update User Type via API
Suppose your automobile dealership firm decides to expand your online booking system to allow customers to schedule test drives, in addition to service appointments. In this case, the dealership may need to update the Customer user type to include the ability to book test drives. You can use the Update User Type API to make such updates.
Request URL : {api-domain}/crm/v4/settings/portals/<portal_name>/user_type/<user_type_id>
Request Method : PUT
Scope : ZohoCRM.settings.clientportal.ALL/UPDATE
Input Keys:
| Key | Description |
| name : string, optional | Name of the user type. |
| personality_module : string, optional | The module api name for which the user type is to be configured. |
| active : Boolean, optional | Represents whether the user type is active or inactive. The default value is false. |
modules : JSONArray, optional | The JSON array containing keys that describe the user type's settings for different modules that are linked to the personality module through look up or multi-lookup fields. |
| modules.layouts.id : Number, optional | The layout the user type should be able to access. |
modules.permission : key value pairs, optional | Boolean key-value pairs that represent the permissions you want the users to have in the module. The possible keys are view, edit, create. |
modules.views : JSONObject, optional | The custom view or canvas view to display the records for the user type. |
modules.id: Number, optional | The related module id. |
modules.shared_type : String, optional | Represents whether the module is a private or public module. |
modules.filters : JSONObject, optional | Field id, by which the module record can be filtered for the user type. |
modules.fields : JSONArray, optional | Field permissions for the user type with read_only (Boolean), api_name(field API name) and id of the each field to be configured for the module. Note that if any of the fields in the layout is marked mandatory, they cannot be read-only in the portal. |
For example, the following request updates the Customer user type's access to the Service module.
Sample Request
https://www.zohoapis.com/crm/v4/settings/portals/ZylkerAutos/user_type/1306462000001856005
Sample Input
{ "user_type":[ { "modules":[ { "permissions":{ "edit":true, "create":true }, "id":"1306462000000000125", "shared_type":"private" } ] } ] } |
Sample Response
{ "user_type": [ { "code": "SUCCESS", "details": { "id": "1306462000001856005" }, "message": "Portal user type updated successfully.", "status": "success" } ] } |
Delete User Type via API
Let us consider the case where your company had a user type for suppliers in its portal but has decided to handle supplier management through a separate system. In this case, you would need to delete the supplier user type from the portal to simplify user management and ensure that only the necessary users have access to the portal.
Request URL: {api-domain}/crm/v4/settings/portals/<portal_name>/user_type/<user_type_id>
Request Method: DELETE
Scope: ZohoCRM.settings.clientportal.ALL/DELETE
For example, the following request deletes the supplier user type from the ZylkerAutos portal.
Sample Request
Sample Response
{ "user_type": [ { "code": "SUCCESS", "details": { "id": 1306462000001857564 }, "message": "Portal user type deleted successfully.", "status": "success" } ] } |
Please note that you cannot delete a user type with users. You should transfer the users to another portal before deleting the user type.
Transfer User to another User Type
There may be scenarios where you have to transfer a user from one user type to another. For instance, if a customer is upgraded to premium level which offers additional services, you might need to transfer the customer to a new user type that includes these features. Also, if you ever have to delete a user type, you need to transfer the users in that user type to another one.
Request URL: {api-domain}/crm/v4/settings/portals/<portal_name>/user_type/<user_type_id>/users/action/transfer
Request Method: POST
Scope: ZohoCRM.settings.clientportal.ALL/UPDATE
Parameters
Parameter | Description |
transfer_to : string, mandatory | The id of the user type to which you want to transfer the users. |
personality_ids : string, mandatory | comma separated list of ids of the users you want to transfer. |
Sample Request
Sample Response
{ "users": [ { "code": "SUCCESS", "details": { "personality_id": "1306462000000659009" }, "message": "User has been transferred successfully", "status": "success" } ] } |
You can transfer up to 200 users in one API call. If there are more than 200 users to be transferred, a job will be scheduled.
Change Status of a User
If you want to change the activate or deactivate a user, you can do so using this API.
Request URL: {api-domain}/crm/v4/settings/portals/<portal_name>/user_type/<user_type_id>/users/<user_id>/actions/change_status
Request Method: PUT
Scope: ZohoCRM.settings.clientportal.ALL/UPDATE
Parameters
Parameter | Description |
active : Boolean, mandatory | To mention whether to activate or deactivate the user. |
The following request changes the status of the user to inactive.
Sample Request
Sample Response
{ "change_status": [ { "code": "SUCCESS", "details": { "personality_id": "1306462000000665004" }, "message": "Status of the user changed successfully.", "status": "success" } ] } |
Delete User from Portal
There may be times when you want to delete a user from a portal to prevent unauthorized access. You may use the Delete User from Portal API to do this.
Request URL: {api-domain}/crm/v4/settings/portals/<portal_name>/user_type/<user_type_id>/users
Request Method: DELETE
Scope: ZohoCRM.settings.clientportal.ALL/DELETE
Parameters
| Parameter | Description |
| personality_ids : string, mandatory | Comma separated ids of the users you want to delete from the portal. |
Sample Request
Sample Response
{ "users": [ { "code": "SUCCESS", "details": { "personality_id": "1306462000000659009" }, "message": "Portal user deleted successfully.", "status": "success" } ] } |
Please note you can delete up to 499 users from a portal synchronously. If you want to delete 500 or more users, a delete job will be scheduled.
We hope you found this post useful, and that it has given you a better understanding of the Portal APIs. See you next week with another useful topic.
If you have any questions or feedback, please let us know in comments below, or write to us at support@zohocrm.com. We would love to hear from you!
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 #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 areKaizen #152 - Client Script Support for the new Canvas Record Forms
Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achievedKaizen #142: How to Navigate to Another Page in Zoho CRM using Client Script
Hello everyone! Welcome back to another exciting Kaizen post. In this post, let us see how you can you navigate to different Pages using Client Script. In this Kaizen post, Need to Navigate to different Pages Client Script ZDKs related to navigation A.
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
Creating a Chart from a Report
In Zoho Analytics, is it possible to create a chart from a Pivot View report? We are looking to use Zoho Analytics to replace Excel for Sales reports and would like to be able to show both the table and the chart together.Ability to Set Client Name During Portal Invitation
Hi Zoho Team, We would like to suggest an important enhancement to the Zoho Creator Client Portal functionality. Zoho Creator recently introduced the option to set a client’s display name in the Client Portal settings, which is very helpful for creatingMove email between inboxes?
Is it possible to move emails from one team inbox to another? We would like to be able to have a single "catch-all" inbox for incoming requests, and then move the email to the appropriate department inbox. I was hoping we would be able to accomplish thisPDF Attachment Option for Service Reports
Hello Team, I would like to check with you all if there is an option to attach PDF documents to the service reports. When I try to attach a file, the system only allows the following formats: JPEG, JPG, and PNG. Could you please confirm whether PDF attachments【Zoho CRM】データ一覧画面でのメモのバッジ機能リリースのお知らせ
ユーザーの皆さま、こんにちは。コミュニティチームの藤澤です。2026年度もゾーホーユーザーコミュニティをどうぞよろしくお願いいたします！ 今回は「Zoho CRM アップデート情報」の中から、新機能のデータ一覧画面でのメモのバッジ機能をご紹介します。 目次 概要 メモのバッジ機能について メモの作成について メモに関する様々な処理について 最近追加したメモについて メモのバッジの非表示について クライアントスクリプトの対応 概要 メモのバッジ機能について 既存の活動バッジに加えて、すべてのタブのデータ一覧表示画面に、各データごとに利用できる「メモのバッジ」（キャプチャ内の赤枠部分）が新たに導入されました。is it possible to add more than one Whatsapp Phone Number to be integrated to Zoho CRM?
so I have successfully added one Whatsapp number like this from this User Interface it seems I can't add a new Whatsapp Number. I need to add a new Whatsapp Number so I can control the lead assignment if a chat sent to Whatsapp Phone Number 1 then assignCan’t find fsm in zoho one
Every other app is available to me in Zoho one except fsmPosibility to add Emoticons on the Email Subject of Templates
Hi I´ve tried to add Emoticons on the Subject line of Email templates, the emoticon image does show up before saving the template or if I add the Emoticon while sending an Individual email and placing it manually on the subject line. Emoticons also showTask Deletion Restriction & Strict Stage Control
Hello Zoho Community, We have the following two issues currently pending and under testing, for which we require a workable and reliable solution: 1. Task Deletion Restriction We are testing ways to ensure that staff users are not able to delete tasksUnable to mass update a picklist field
Hello, I have the records within our Accounts module divided between two account types: Parent Accounts & Member Accounts. I am attempting to mass update accounts from one picklist value to the other (within other specific criteria in our custom fields)Process checklist in CRM
Hi We've created a new sales process that I'm mapping into the CRM - issue I have is that some of the tasks / milestones I would like to capture require very simple tick box responses but there are quite a few under a variety of sub categories so I don'tCRM project association via deluge
I have created a workflow in my Zoho CRM for closing a deal. Part of this workflow leverages a deluge script to create a project for our delivery team. Creating the project works great however, after or during the project creation, I would like to associateHolidays - Cannot Enter Two Holidays on Same Day
I have a fairly common setup, where part-time employees receive 1/2 day's pay on a holiday and full-time employees receive a full day's pay. Historically, I've been able to accommodate this by entering two separate holidays, one that covers full-timeWhere is the settings option in zoho writer?
hi, my zoho writer on windows has menu fonts too large. where do i find the settings to change this option? my screen resolution is correct and other apps/softwares in windows have no issues. regardsFile emails in Shared email folder
Hi, I am unable to allow users to collaborate in Shared email folders: User 1 shares a folder let's say "SharedTopic" with full permissions Users 2 and 3 can see this folder but are unable to add emails to this folder or search in this folder. For example,How create a draft via workflow?
I wish to create a workflow rule for specific emails that creates a draft response - not an automatic email reply, but just a draft with a set response ready to be verified by an agent who can then manually select recipients. Alternatively, the workflowThis user is not allowed to add in Zoho. Please contact support-as@zohocorp.com for further details
Hi Team, when I,m trying to create a email account (imagixmidia.com.br) it's showing this error >> This user is not allowed to add in Zoho. Please contact support-as@zohocorp.com for further details plz help me thanksHow to manage task lists in Zoho Desk?
Hello, I use Zoho Desk for IT customer support. I have a list of standard operating procedures (SOPs), including SOPs for onboarding new users, offboarding users, losing a device, etc. These are lists of tasks to be performed depending on the situation.Zoho → ShipStation Integration – Sales Order–Driven Fulfilment Workflow
Hello All, I’m reaching out to explore the best way to integrate a shipping tool into our inventory which will speed our process up. We are looking to integrate ShipStation into our existing order-to-fulfilment workflow, as we’re keen to standardise onBusiness Day Logic Update: More Accurate Scheduling for Your Workflows
Hello everyone, We’re improving how business-day calculations work in workflows, especially when triggers happen on weekends. This update ensures that offsets like +0, +1, and +2 business days behave exactly as intended, giving you clearer and more predictableConvert Lead Automation Trigger
Currently, there is only a convert lead action available in workflow rules and blueprints. Also, there is a Convert Lead button available but it doesn't trigger any automations. Once the lead is converted to a Contact/Account the dataset that can be fetchedDefault Tagging on API-generated Transactions
If one assigns tags to an Item or Customer, those tags get auto-populated in each line item of an Invoice or Sales Order when one creates those documents. However, if one creates the Sales Order or Invoice via the API (either directly coding or usingUser
If user is already part of manage engine endpoint central , what hapens when i try to add them to another Zoho org / directory? Are these users added as external users?Adding a new section to the related details sidebar when creating a new ticket.
Hello, I was wondering if you can add a new section to the related details sidebar when creating a new ticket. I was wanting to have it to where it also shows the account information related to the contact chosen as well. This is the section I am referringDisplaying only unread tickets in ticket view
Hello, I was wondering if someone might be able to help me with this one. We use filters to display our ticket list, typically using a saved filter which displays the tickets which are overdue or due today. What I'd really like is another filter thatHow to compare a subform lookup field that allows multiple entries when edited
I have a form with a subform with multiple fields. One of the fields is a lookup field that allows a multi select. On edit validation, I want a workflow to execute only when the entries in that subform field has changed. The old. function is not workingIs Zoho Shifts included in the Zoho One plan?
In case the answer is no: there's any plan to make it available via One? Thank youZoho Tracking Image location
So we've been having an issue with tracking email opens. Specifically in Gmail. Our emails are not that long either, maybe 4 sections of image/250 characters of text/button per section. But all my test accounts I used via Gmail we're showing opens. But then come to find out the tracking image is at the very bottom of the email. So If the message is clipped (It always just clips our social icons on the bottom) and the user doesn't click the show more button it never tracks the open. Looking at otherIs there a plan to integrate zoho voice with zoho books?
Hello, Is there a plan to integrate zoho voice with zoho books? Right now we are using the Twilio SMS integration into zoho books, but have recently decided to switch to zoho voice for calls and sms. Is there a plan to integrate zoho voice natively intoZoho Tables is now live in Australia & New Zealand!
Hey everyone! We’ve got some great news to share — Zoho Tables is now officially available in the Australian Data Center serving users across Australia and New Zealand regions! Yes, it took us a bit longer to get here, but this version of Zoho TablesDelivery and handling of documents e-stamped using Zoho Sign
Hello everyone! Zoho Sign makes it easy to pay non judicial stamp duty online and automatically attach the digitally generated e-stamp challan to electronic documents. We also manage the delivery of physical e-stamped papers. We periodically receive theseIntroducing Dedicated Modules for Plans, Addons, and Coupons in Zoho Billing
We’ve enhanced the way you manage Plans, Addons, and Coupons in Zoho Billing. Previously, all three grouped together under Subscription Items. Now, each one has its own dedicated module, giving you a cleaner and more intuitive experience. This updateSortie de Zoho TABLE ??
Bonjour, Depuis bientôt 2 ans l'application zoho table est sortie en dehors de l'UE ? Depuis un an elle est annoncée en Europe Mais en vrai, c'est pour quand exactement ??Issue with WhatsApp Template Approval and Marketing Message Limit in Zoho Bigin
We are facing issues while creating and using WhatsApp message templates through Zoho Bigin, and we request your clarification and support regarding the same. 1. Utility Template Approval Issue Until December, we were able to create WhatsApp templatesHow to install Widget in inventory module
Hi， I am trying to install a app into Sales Order Module related list, however there is no button allow me to do that. May I ask how to install widget to inventory module related list?Zoho Social - Feature Request - Non-US Date Format
Hi Social Team, I have noticed that there is no option to change the date format from US mm/dd/yyyy to others like dd/mm/yyyy. It would be great to see this added as the platform matures. Thanks for considering this feedback.Drop Down Value
Hi, May I know why Zoho Flow treat this drop down as number and not as string. If so, how can I fetch the right value for filtering. This field is from Creator, in Creator upon checking by default it is a string since it's not a lookup field.Zoho CRM's mobile apps: A 2025 Recap
2025 marked a year of steady progress for Zoho CRM's mobile apps. We rolled out several updates and features to improve usability and make everyday CRM work a lot easier to manage. Here’s a look back at some of the key releases from 2025. Android releasesFacebook follower count doesn't match FB Analytics
Hi all, I am wondering if anyone else has issues with follower counts for Facebook not matching FB's native analytics tool. On the Zoho dashboard, it's showing 1,007, but FB shows 1,060. All the other channels match up. Any insights are much appreciated!Meta and Facebook data report discrepancy
I have been currently gathering manually facebook follower data thru meta. In zoho marketing plus the social media reporting only allows for page likes, and so there is a discrepancy with the data. please the difference in files attached. Is there wayNext Page