Kaizen #51 - Handling Users with ZohoCRM API
Hello everyone!
Welcome back to yet another post in the Kaizen series.
This week, we will discuss the Zoho CRM Users API in detail.
Users in Zoho CRM
A user is the one who is allowed to access and manage the CRM records. Generally, anyone using CRM is a user. Further you can assign profiles and categorize the users based on their roles and permissions.
There are 4 major operations in Users API:
1. Get User(s) Data
2. Add User
3. Update User
4. Delete User
Note:
1. The oauth scopes required for all the mentioned Users API:
ZohoCRM.users.all (or) ZohoCRM.users.{operation_type} |
2. The possible operation types are:
a. READ - Get User Data
b. CREATE - Create User Data
c. UPDATE - Update User Data
d. DELETE - Delete User Data
To fetch the users data specified in the API request. The data to be fetched can be trimmed based on the user categories like AllUsers, ActiveUsers etc.
Request Method: GET
Request URL:
a. To fetch multiple users:
{{api-domain}}/crm/v2/users
b. To fetch a specific user:
{{api-domain}}/crm/v2/users/{user_id}
a. Sample Request:
{{api-domain}}/crm/v2/users?type=AllUsers
Let us see the parameters applicable to this API and their possible values:
Parameter Name | Data Type | Description and Possible Values |
type | String | Specify the type of users to fetch. |
page | Integer | Specify the list of user records as per their position in Zoho CRM. Default value is 1. |
per_page | Integer | Specify the number of user records to be retrieved per page. Default value is 200. |
Let us see the possible type of users in an organization:
User Type | Description |
AllUsers | To list all the users in your organization (both active and inactive users). This is the default user type. |
ActiveUsers | To get the list of all Active Users |
DeactiveUsers | To get the list of all users who were deactivated |
ConfirmedUsers | To get the list of all the confirmed users |
NotConfirmedUsers | To get the list of all the non-confirmed users |
DeletedUsers | To get the list of all the deleted users |
ActiveConfirmedUsers | To get the list of all the active and confirmed users |
AdminUsers | To get the list of all the admin users |
ActiveConfirmedAdmins | To get the list of active users with the administrative privileges and are also confirmed |
CurrentUser | To get the current CRM user |
Sample Response:
b. Sample Request to fetch a specific user:
{{api-domain}}/crm/v2/users/3719520000000191015
Sample Response:
To add an user to the organization.
Note: You can add only one user per request and you require to add Field API names in input. It can be fetched from Fields Meta Data API
Request Method: POST
Request URL:
{{api-domain}}/crm/v2/users
Mandatory keys in Request JSON
Key | Data type | Description |
last_name | String | The last name of the user. |
email | Email | The Email ID of the user |
profile | String | The unique ID of the role to assign the user with. It can be obtained from the Roles API. |
role | String | The unique ID of the profile to assign the user with. It can be obtained from the Profiles API. |
Other than the mentioned mandatory keys, the input Json can contain the system-defined fields and custom fields such as Single Line, Currency, URL and Checkbox.
Sample Request JSON:
{ "users": [ { "role": "3719520000000026005", "city": "Chennai", "state": "Tamil Nadu", "first_name": "John", "email": "john.mclane@zohocorp.com", "website": "www.zoho.com", "profile": "3719520000000026011", "last_name": "Mclane" } ] } |
Sample Response:
To update the details of a user of your organization. You will require to mention the user_id. The user_id can be obtained from Get Users API.
Request Method: PUT
Request URL:
If you intend to provide the user_id in the body as Json.
{{api-domain}}/crm/v2/users
If you intend to provide the user_id in the request URL.
{{api-domain}}/crm/v2/users/{user_id}
Note:
a. A deactivated user cannot be updated.
b. To activate/deactivate a user, use 'status' key in the input with the specified operation (active for activating and inactive for deactivating) as the value.
b. The time zone for another user cannot be updated, you can update your own time zone
Sample Request JSON:
You can update only one user per request. I am updating the city of the user that we added in Add User Operation.
{ "users": [ { "city": "Banglore" } ] } |
Sample Response:
To delete a user from the organisation. You will require to mention the user_id. The user_id can be obtained from Get Users API.
Request Method: DELETE
Request URL:
If you intend to provide the user_id in the body as Json.
{{api-domain}}/crm/v2/users
If you intend to provide the user_id in the request URL.
{{api-domain}}/crm/v2/users/{user_id}
Sample Request:
{{api-domain}}/crm/v2/users/3719520000001093002
Sample Response:
Note:
a. By providing the type as 'DeletedUsers' in Get Users API, the deleted records can be fetched.
b. Deletion of primary contact is denied. To delete the primary contact, you will need to assign another contact as new primary contact.
Some common errors pertaining to Users API and ways to handle them:
HTTP Status Code | Error Code | Message | Reason/Handling |
200 | INVALID_DATA | The ID given seems to be invalid | You might have provided the incorrect ID in the request. Kindly provide the appropriate ID. The ID of a user can be obtained from Get Users API. |
400 | DUPLICATE_DATA | Failed to add user as the email id is already present. | The user already exists in the organisation |
400 | MANDATORY_NOT_FOUND | One of the mandatory key is missing. | Check if you have provided all the mandatory keys in the request. |
400 | LICENSE_LIMIT_EXCEEDED | Request exceeds your license limit. Need to upgrade in order to add | The maximum number of users you can add per your CRM plan has exceeded. |
400 | INVALID_REQUEST | Primary contact cannot be deleted. | You cannot delete the primary contact of your organization. |
400 | ID_ALREADY_DELETED | User is already deleted. | The user you want to delete is already deleted. |
403 | INACTIVE_USER | Inactive user cannot access the API. | Activate the user and then perform the desired operation. |
These are the 4 major operations in Users API. Zoho CRM currently doesn't avail Search User API. It is currently in the development stage and it will be released soon.
We hope you found this post useful. Let us know your thoughts in the comment section or reach us out at support@zohocrm.com.
Cheers!
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
Srivathsan N V
Sticky Posts
Kaizen #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.Kaizen #210 - Answering your Questions | Event Management System using ZDK CLI
Hello Everyone, Welcome back to yet another post in the Kaizen Series! As you already may know, for the Kaizen #200 milestone, we asked for your feedback and many of you suggested topics for us to discuss. We have been writing on these topics over the
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
Start Workflow from Deluge Script
I have developed a customized process from our CRM that leverages a deluge script to create a statement of work document. Once the document has been created via the merge and store function, I would like the ability to start a workdrive review & approveRequest for Auto PO - Min–Max based Automated Purchase Feature
Dear Zoho POS Team, I’m writing to request a feature enhancement that would significantly streamline inventory management for businesses using Zoho POS — particularly supermarkets, FMCG retail, and multi-store operations like ours. Feature Requested:Masters in UK – Experiences, Universities, and Career Outcomes
This forum discussion is for students who are planning or considering a Masters in UK and want to gain practical insights beyond official university websites. The UK attracts international students due to its globally recognized universities, diverseExport your notes from Notebook!
Dear users, The long awaited feature is now live. Yes, you can now export your notes from Notebook app in bulk. But the feature has just started with web app alone for now. You can try the export feature as mentioned below: Go to our web app, https://notebook.zoho.com Go to 'Settings' > 'Export' Now, select the format: You can select either ZNote or HTML Once done, you can use the same to import or can have this a local backup of your notes. Note: Export for other platforms are in development andPrepopulating Fields
Hello, I have a form (Assets) with 2 lookup fields: Client (from Clients) Site (from Client Sites) I modified the code (highlighted in red below), so the Site dropdown shows the list of sites related to the Client. must have Client_Site ( type = picklistUnable to sort as Descending order
Trying to change the sort order for a lookup field (checkboxes) from Ascending to Descending and keep getting an error in Deluge that the order must be Ascending Did anyone ran into this? Thanks EyalExport Invoices to XML file
Namaste! ZOHO suite of Apps is awesome and we as Partner, would like to use and implement the app´s from the Financial suite like ZOHO Invoice, but, in Portugal, we can only use certified Invoice Software and for this reason, we need to develop/customize on top of ZOHO Invoice to create an XML file with specific information and after this, go to the government and certified the software. As soon as we have for example, ZOHO CRM integrated with ZOHO Invoice up and running, our business opportunitiesCan I change the format of the buttons in the email templates?
Hi all! We have been working hard trying to brand our email templates, and have some way to go yet. One of the things we can't seem to edit is the green ${Cases.CUSTOMER_PORTAL_BUTTON} button and the font of the View Ticket text. Is there any way of doingissue with deluge script
i used chat gpt to build this script and I am getting 2 errors which I cannot figure out how to fix: void monthly_sales_order_generation() { try { // ---------------- CONFIG ------------------- analytics_url_1 = "https://analytics.zoho.com/api/<workspaceID>/report/<reportID1>/data";Introducing LinkedIn Apply Connect for Zoho Recruit
Attract up to 3x more qualified candidates and hire more efficiently with LinkedIn Apply Connect. Let candidates fill-in job applications without any redirections, gain deeper insights with applicant highlights within Zoho Recruit, and keep candidatesRecruit paid support?
Hi all, Could anyone who has paid support package advise if it provides value for money with regards to support response times? Exploring the idea as unfortunately when we have faced issues with Recruit it has been a 7+ day timescale from reporting toIntroducing 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 updateTicket Status email
Good day, This was discussed in the past, but it would be helpful if we could have the system assign a custom response to a status. We have various statuses for tickets, e.g. "closed due to no response", or "Pending Status", it would be helpful for theCustomer ticket creation via Microsoft Teams
Hi all, I'm looking to see if someone could point me in the right direction. I'd love to make it so my customers/ end users can make tickets, see responses and respond within microsoft teams. As Admin and an Agent i've installed the zoho assist app withinHolidays
Hi; For defining Holidays, you need to add logic to handle the year as well as the month & day. We need to be able to enter Holidays for the next year. I need to add a holiday for January 2, 2017, but I can't until January 1st, which is a Sunday and weCan I use a Standalone CRM Function as the Callback URL For Async Export Data API?
I am creating an export job using this API https://www.zoho.com/analytics/api/v2/bulk-api/export-data-async/create-export/view-id.html There is a "callbackUrl" key in the CONFIG object. I tried copying the URL for a standalone function in CRM which canFuture Orders - Due Date
Hi In my role, I can receive tickets where the work required is requested months in advance. Using a Future Orders option, which I believe was setup under the On Hold status type, hides the Due Date, in all views/ticket etc. Whilst I understand the reasoningIntroducing Withdrawal Reasons for Offers
We’re excited to introduce a new enhancement to the Offer module that brings more clarity and accountability to every withdrawn offer. The Withdrawal Reason update ensures that each withdrawal — manual or automatic — is backed by a clear explanation,Zoho Creator customer portal users
Hi, I'm in a Zoho One subscription with our company. I'm running a project now that involves creating a Zoho Creater application and using the Zoho Creator Customer Portal. At most we need 25 customer portal users. In our Zoho One plan we only get 3GPS tracking only or Check out facility
Dear Team, Zoho CRM is quite robust CRM but till date i was waiting for the feature of having GPS tracking of Sales employees which is a common demand by all customers for thier field sales executives. We cover them by saying that CRM provides CheckinHTML Tags added to Reports with Notes
Recently Zoho added the ability to markup text within notes. That way, users can change font size, colors, etc. It's a great change. However, since the change, reports that include a column for "Note Content" are printing HTML tags within the report.In App Auto Refresh/Update Features
Hi, I am trying to use Zoho Creator for Restaurant management. While using the android apps, I reliased the apps would not auto refresh if there is new entries i.e new kitchen order ticket (KOT) from other users. The apps does received notification but would not auto refresh, users required to refresh the apps manually in order to see the new KOT in the apps. I am wondering why this features is not implemented? Or is this feature being considered to be implemented in the future? With theAppraisals on Employee Information Profile
Is it possible to show completed appraisals on each employee's "Employee Information" page? I would presume at the bottom - similar to the "Related Lists" concept in Zoho CRM. Obviously view access would be limited to employee and appropriate other rolesAI Interview Insights: Turn Recorded Interviews into Quick Transcripts & Summaries
Evaluating interviews shouldn’t require replaying long recordings or taking manual notes. With AI Interview Insights, you can now review complete transcripts and AI-generated summaries of your One-way (Recorded) interviews right inside Zoho Recruit. ThisKaizen #220: Actions API - Webhooks APIs - Part 2
Hello all!! Welcome back to the follow-up Kaizen post of Kaizen #219: Actions API - Webhooks APIs - Part 1. In the previous week, we covered how to configure a basic Webhook and how to include Headers, Body, and URL Parameters using both the POST WebhookStandard Payment Term is not pulled from account to quotation
Hey Team There seems to be something off. I do have "Net 30" as my default payment term in Zoho Books for my customers. If, from the customer overview or quote section, I create a new Quotation, the payment terms field stays blank and doesn't get theCanva Integration
Hello! As many marketing departments are streamlining their teams, many have begun utilizing Canva for all design mockups and approvals prior to its integration into Marketing automation software. While Zoho Social has this integration already accomplished,Manage your invoices from Bigin's mobile app (iOS)
Hello everyone! We're happy to announce that users can now integrate Zoho Books with the latest version of Bigin's iOS app. Zoho Books can be integrated with Bigin only via the web application. Users can view the Zoho Books tab in the detail pages ofHubSpot CRM to Zoho Creator Integration
I'm trying to create an integration between HubSpot CRM and Zoho Creator with HubSpot being the push source (if a contact is created or updated in HubSpot, it pushes the information to Zoho Creator). I have two questions: 1- Is it best to use Zoho FlowSystematic SPF alignment issues with Zoho subdomains
Analysis Period: August 19 - September 1, 2025 PROBLEM SUMMARY Multiple Zoho services are causing systematic SPF authentication failures in DMARC reports from major email providers (Google, Microsoft, Zoho). While emails are successfully delivered dueAccessibility controls and multilingual captcha authorization for Help Center users
Hello everyone, As part of our ongoing effort to improve user experience, we are excited about the accessibility controls and predefined accessibility personas added in the Help Center, similar to what is already available in Zoho Desk. Help Center usersGain control over record sharing with portal users through our new enhancement: criteria-based data exposure
Dear Customers, We hope you're well! Portals is a self-service avenue through which your clients can access and manage their direct and related data in Zoho CRM. This empowers them to be more independent and enables them to experience a sense of transparencyZoho Sign + Zoho CRM : la solution pour simplifier vos accords de vente
La conclusion d’un contrat de vente nécessite de nombreuses étapes : préparation de documents, validations successives et collecte des signatures. Les équipes commerciales passent souvent par plusieurs cycles de collaboration et de révision, tout en assurantZoho Desk Limitations
Good day, all, I would like to know whether others share my frustration with some of Zoho's limitations. Don't get me wrong, I like Desk (and I also have a subscription for Analytics), I have been with them for close to 10 years, and unfortunately, IItem/service subtotal
Just discovered & really pleased that we can drag to re-order the line items in Sales orders & Invoices, a very nice feature which doesn't seem to be documented? It would be nice to be able to insert a subtotal as a line item to complete this great featureConverting Sales Order to Purchase Order
Hi All, Firstly, this code works to convert a sales order(SO) to a purchase order (PO) via a button, however I am running into an issue when I convert the SO where the values from the line items are not pulled across from the SO to the PO. The ones inhow to Solve Conflict Invoices in Zoho POS
Hello Team, I am facing a repeated issue in Zoho POS while saving a sale that contains service-based items. My products are intentionally created as Service (Non-Inventory) items because I do not want to track stock for them. However, every time I tryAll new Address Field in Zoho CRM: maintain structured and accurate address inputs
The address field will be available exclusively for IN DC users. We'll keep you updated on the DC-specific rollout soon. It's currently available for all new sign-ups and for existing Zoho CRM orgs which are in the Professional edition. Latest updateCopy, Paste, Highlighted text
when i copy paste text it gets highlighted. Fix this. WTF is with this black highlight ? Fix copy pasting. Some people pay for using this mail service.Pricing Strategies: #6 Common Mistakes while Configuring Pricing
"Why does this month's billing feel messy again?" That was the exact line Priya muttered while staring at the spreadsheet full of edited pricing, one-off discounts and mismatched subscription details. Her business was growing, but the pricing machineNext Page