Portal APIs in Zoho CRM - 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
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
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! CommandsKaizen #165 : How to call Zoho CRM APIs using Client Script
Welcome back to another exciting Client Script post! In this post, we will discuss one of the most frequently asked questions: How do you call Zoho CRM APIs from Client Scripts? In this kaizen post, 1. Ways to make calls to Zoho CRM APIs using ClientKaizen#162 : Add Tags and Open Pre-filled Email Drafts via Client Scripts
Hello everyone! Welcome to another informative Kaizen post. In this post, let us see how to accomplish the following using Client Script. 1. How to auto-tag a record based on field update? 2. How to Open a pre-filled email draft This post will provideExtension Pointers - JS SDK series #4: Managing data from a widget using ZOHO.CRM.HTTP
Handling and managing the data between two applications is a major factor for an efficient business. There are a variety of ways to handle data between Zoho CRM and other third-party applications. You can use deluge CRM tasks, create connectors, use APIKaizen #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 achieved
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho DataPrep Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho Campaigns 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
CRM x WorkDrive: File storage for new CRM signups is now powered by WorkDrive
Availability Editions: All DCs: All Release plan: Released for new signups in all DCs. It will be enabled for existing users in a phased manner in the upcoming months. Help documentation: Documents in Zoho CRM Manage folders in Documents tab Manage filesCreate a button that executes a customized function
Hello, I have created a summary view in which I combine the data from my items table and suppliers table. I would like to know if there is the possibility of adding a button somewhere in the view to be able to execute a function when clicked on it. ICustom field doesn't fill when converting sales order to invoice
Hi, When I convert a Sales Order to an Invoice one of the custom fields on a product line names "Subsidie" does not seem to fill in automatically. I manually have to select the product again by clicking on the product name in the order line en re-selectCan I use ZOHO calendar to schedule a Youtube video that is already in my youtube account, but listed as private or unlisted?
I am creating Youtube videos and shorts and then uploading them to our Channel so others can view and approve. Once approved I would like to just schedule them over the next few days within Zoho. So far it looks like I have to re-upload the video to ZohoHow to Display a Logo Image on a Public Form?
I would like to display a logo image in the header of a form. To achieve this, I added an Add Notes field to the form. The code below works perfectly for Zoho users accessing the form. However, when the form is made public, the image does not load properly:Advice for my first project in Zoho
Hello, how can I design and implement a customized ERP and CRM system using Zoho to automate and manage core business functions, including customer relationship management, property inventory, sales tracking, and financial processes. This is one of myAssociate Email API Internal Error
I am trying to associate an already existing email within a function using the Related Emails API. To provide more context, I also have admin permissions and have ensured that the fields are correct and that I have admin permissions when associating theProfit on Sales order
Hi, would it be possible to implement a column at the Sales order overview of Purchase amount? So a field with the amount of all purchase related to this Sales order? This is very usefull so you will see the profit you made on this deal. I tried to getSubform Data in v2 REST API
What is the mechanism for adding subform data in the Creator v2 REST APIs? There is nothing documented in the Data APIs documentation (https://www.zoho.com/creator/help/api/v2/). I was able to determine how to GET the subform data by adding it to theIs the filename of an attachment restricted to only certain languages?
Hi, I tried to create a file card in a notebook, but I encountered an issue: when the filename of an attachment is in languages other than the main ones (such as English, Japanese, or Simplified Chinese......), syncing stops or the filenames become garbledHow to create comparison time periods like these examples
In a Pivot Report I would like to be able to select any date range and show a set of metrics for that date range e.g. revenue, orders, units sold. I would then like to be able to compare to the previous period based on the amount of days on the selectedOverwrite Option for custom modules
Hi Team, I noticed that the overwrite option is unavailable in Zoho Books when importing data for custom modules. This limitation makes it challenging to bulk update old data, as the only option is the 'bulk update' feature, which is restricted to 25Zoho Creator - Zoho Analytics
I am facing an issue in Zoho Analytics where I am still seeing deleted data from the Zoho Creator form I created. Could you please look into this and let me know what needs to be done?Unable to send emails
I have this email parth@mrcolumbus.in, but I couldnt send outgoing email. Can you please help?Notifications push : Encourager le réengagement et renforcer la fidélité des utilisateurs efficacement
Vous avez déjà souhaité engager et communiquer de manière proactive avec les utilisateurs, y compris lorsqu'ils utilisent votre application de manière peu active ? Zoho Apptics vous offre déjà des fonctionnalités qui vous permettent d'évaluer la performance,Easy way to delete attachments
I've reached my data limit and would like to run a view/report, and mass delete attachments. Is there an easy, fast way to do this? Moderation Update: Post Summary: There are two features the post discusses a) Easy way to remove Email attachments WillHow to add new deal to existing contact
Hi, I want to add new deal to existing contact.Domain verification is in progress... (How long do I need to wait?)
Trying to setup my first email domain by connecting with GoDaddy. Have been here for quite some time and the screen is not changing. How long should this take?Send DataSend Dataemail address autocomplete
Is there a way to eliminate certain addresses from showing up in auto complete when entering an address? Many old and unused addresses currently show up, many of which I would like to get rid of. ThanksLinking an email to a Contact when the email is sent in deluge via sendmail
The "to:" address in this code is a CRM Contact. Email address is forced unique in CRM This sendmail gets sent via a workflow which is in a custom module. It works, except that the outbound email does not appear (i.e, get linked to) the Contact such thatHow to restore deleted Field
I edited a field in zoho form and by accident I deleted a field (email address). The form is ongoing to be filled by respondent. Then, when I checked to the all entries and report, the email address is gone. I checked in audit log, there is a record thatHow to select multiple notes at once in the PC client?
In the PC client, you can select notes using ctr+LMB. But why can't you use shift+LMB? PC version 3.2.0How I can add customized Invoice
Hi, I wanna use a customized Invoice, how i can add thatZoho Analytics Pivot Table - How to compare month vs last year same month
Hi, I had created a pivot table with setup as below: Column: - Delivery Date Row: - Customer Group Data as column - Total amount (sum > normal) (show data of the month) - Total amount (sum > % difference from previous value) (compare between this monthRecorded imported goods
I have imported some goods from a foreign vendor called ABC. to Bahrain. My Customs duty and VAT are paid by an agency called XYZ to authorities. I have paid the amounts to XYZ and they have paid to authorities in behalf of us using our TRN Number. NowNotes created in mobile app not syncing with web notebook
I have created certain notes in a new notebook in mobile app. The new notebook is also created using mobile app and when I logged in through web I am unable to see notebook that I have created using mobile app. there is no trace of notes in which i have created in mobile app on the web even after days of creating in mobile app This is not the case vise-a-versa. the notes and note book created on web are accessible on mobile app on real time. this is very inconvenient and big demotivating factorMatch Transaction > Filter | Allow wildcards in search
The Filter function is useful for narrowing down to a specific set of transactions. It would be useful to have the ability to use wildcards in search. e.g. customer name "starts with" or " * " as a placeholder. e.g. "National * " instead of "NationalMarketing Automation Emails Going to Spam
Google is trapping all the marketing automation emails in spam. My domain has a perfect reputation and it looks like Zoho has a low reputation which is sending it to spam. When I pull the email out of spam and click on a link in the email, I get thisConvert Request to Forum Topic
I know you can convert a forum topic to a request and a request to a solution in the knowledge base, but how do you convert a request to a forum topic? Is this possible? If not is this a feature coming down the pipe in the near future? Thanks!Zoho Sign / Prefill By You - Editable by Them!
Zoho Sign seems to have two field options available - an empty field for signer(s) to complete or a field that has been prefilled by you, that becomes read only once sent. What I would like is an option on the pre-filled by you fields, to leave themIs the Contacts sync between Campaigns and CRM bi-directional?
Is the Contacts sync between Campaigns and CRM bi-directional?Task does not syncing to google calendar shedual
Hi why does the tasks activities do not syncing with the google calendar like the event option does?Bug with Zobot Human transfer
I have configured the brand, the operator, and the Zobot in Spanish. However, no matter what I do, it always says "YES" instead of "Sí" or "Sure, why not " instead of "Claro, ¿por qué no?" when asking if the user wants to contact a human operator. TheThis mobile number has been marked spam. Please contact support.
Hi Support, Can you tell me why number was marked as spam. I have having difficult to add my number as you keep requesting i must use it. My number is +63....163 Or is Zoho company excluding Philippines from their services?Something went wrong. One or more fields contain errors
I am getting this error but there is no way to debug what field is causing the issue . I have over 100 fields. Everything was working fine and then i fixed some fields that should have the same field names but had a typo and i am getting this error. ItIntegrating Zoho Desk Instances from two separate organizations
Is it possible to integrate Zoho Desk with an instance from another organization? For example, creating a ticket in one organization can cause the creation of a ticket in the second organization? Or certain tickets from one organization be viewable byKnowledge base bug - Error: Article couldn't be updated.
It took me a while to figure this out, truly one of the most irritating bugs in Zoho. I hope you find this information helpful. When using the knowledge base to create articles, make sure your keywords are in lowercase and separated by commas. Otherwise,Is this possible with Campaigns?
My company is currently moving CRM's from Monday to Zoho One. Currently, our marketing lead process is send out 7 sms messages over 14 days if the lead is in a certain status. If we don't get a response the lead is put into a "Closed" status. Do we buyHow to view two portals (Zoho CRM & Zoho Books) in single login
Hello there, I need to create a portal access for the Customers. Customer data present in two applications namely Zoho CRM & Zoho Books. My requirement is to show the two different portals(Zoho CRM Portal & Zoho books Portal) in single login. I couldUpdating Bounced Contacts in Campaigns to the CRM
The article explains how to update Opt-outs from Campaigns to CRM, but not bounces. While Campaigns will automatically remove any bounced emails from future campaigns, is there a process by which a bounce will update or make a notification in the CRMNext Page