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
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
Srivathsan N V
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
Ability to translate Zoho CRM Kiosks
Hi team, Is support for translating kiosk text and screen names in the Zoho CRM translation tool planned on the roadmap? Thanks,Whatsapp Limitation Questions
Good day, I would like to find out about the functionality or possibility of all the below points within the Zoho/WhatsApp integration. Will WhatsApp buttons ever be possible in the future? Will WhatsApp Re-directs to different users be possible basedEditing the list of Categories in the Categorize Manually section of Banking in Zoho Books
Hi, I need to create two new Categories called Withdrawals and Deposits to categorize payments in a bank account. How do I edit the Categories list?Can I write a check in Zoho Books with no associated bill?
This currently does not seem possible, and I have a client that desperately needs this function if I am able to convert them with Quickbooks. Thank you in advance for your reply.Internal Fillable Contract with Zoho Writer (Before Sending to Client)
Hi everyone, I’m trying to automate the following process in Zoho CRM and would appreciate some guidance. Process: When a Deal moves to a specific stage, CRM triggers an automation. CRM sends a contract template to an internal team member so they can[Free Webinar] Intelligent document processing with Zoho RPA
Hello everyone! Greetings from the Zoho RPA team! We're excited to invite you to our upcoming webinar on intelligent document processing with Zoho RPA, where we'll introduce powerful new capabilities designed to make your automation journey smarter, faster,Enhancements for Currencies in Zoho CRM: Automatic exchange rate updates, options to update record exchange rates, and more
The multi-currency feature helps you track currencies region-wise. This can apply to Sales, CTC, or any other currency-related data. You can record amounts in a customer’s local currency, while the CRM automatically converts them to your home currencyWhen I schedule calendar appointments in zoho and invite external emails, they do not receive invites
Hello, We have recently transitioned to zoho and are having a problem with the calendar feature. When we schedule new calendar appointments in zoho the invite emails aren't being sent to the external users that we list in participants. However, this worksSend emails directly via Cases module
Greetings all, The ability to send emails from the Cases module, which users have been eagerly anticipating, is now available, just like in the other modules. In Zoho CRM, Cases is a module specifically designed for managing support tickets. If your organizationWebinar Alert: Supercharge landing pages with data insights | Zoho LandingPage
Every visitor to your landing page leaves behind valuable data, but are you leveraging it to improve conversions? Join our expert-led Landing Page Analytics webinar to learn how to track, analyze, and optimize landing page performance with Zoho LandingPage’sBulk Deletion of Zoho Projects Using Node.js and Zoho Projects API
Zoho Projects currently does not provide a built-in option to delete multiple projects in bulk from the UI. When working with testing environments or large numbers of temporary projects, deleting them one by one becomes time-consuming. To address this,Show unsubscribed contacts ?
Hello, I would like to display the unsubscribed contacts. Unfortunately, I do not have this subscription type as described in the documentation (https://help.zoho.com/portal/en/kb/marketing-automation-2-0/user-guide/contacts/contact-management/articles/subscription-type-24-1-2024#Subscription_Type_field.)Track Marketing Automation Campaigns in Zoho CRM
Hello, I've been searching but haven't found the exact answer to this question. I am looking to track Marketing Automation email campaigns and activities inside of Zoho CRM. Use Case: Action: Prospect Submits A Lead Form Outcomes: Prospect created inValidation rule for Date field
The condition settings for a Date field are are absolutlly usless. Conditions can only be set for a specific date, which is logically ineffective in most cases. When setting a condition for a Date field, users usually need to compare the value relativeEasily map shift data fields during user imports
Greetings all, You can now include all your shift-related data for your users without any hassle during user imports. With this enhancement, the Map Import Fields to Zoho CRM option includes all shift-related fields: Current Shift, Next Shift, and ShiftUnable to send
Hello, I am unble to send any single email during the whole time due to the Zoho IP 136.143.188.16 being bloked by SpamCop.net Please help can somebody help me?Adding new data to the sheet with most recent data being added to top row.
I am using a form that I built from within sheets. When the form is submitted, is it possible to have the data entered in (for example) row 2 (since row 1 is the heading) instead of being added into the next available row which should be hundreds ofHow do you arrange order in which the speakers are listed in a session once they have been selected?
Probably another simple thing I've missed but I can't find how to arrange the order in which the speakers are listed in a session once they have been selected. We usually want the speakers listed alphabetically by last name, but sometimes not. Once theProduct Updates in Zoho Workplace applications | February 2026
Hello Workplace Community, Let’s take a look at the new features and enhancements that went live across all Workplace applications for the month of February. Zoho Mail Organize Personal Notes with Collections You can now create collections under My PersonalIntroducing note actions and dynamic visibility in Kiosk Studio
Hello all, We are introducing enhancements to Kiosk Studio that will improve the product scope and meet your custom needs more precisely. What's new? Add notes as Actions: You can add notes to CRM records as kiosk Actions, as well as insert merge fieldsRegarding the Recipient Email change
I was not being able to change the Recipient email. Kindly resolve the problemRequest to Customize Module Bar Placement in New Zoho CRM UI
Hello Support and Zoho Community, I've been exploring the new UI of Zoho CRM "For Everyone" and have noticed a potential concern for my users. We are accustomed to having the module names displayed across the top, which made navigation more intuitivekanban view for client portal
Are kanban views an option for client portals? Access to Kanban views in the client portals would solve some mobile-compliant issues I have with the UI. Kanban functions very nicely on mobile and would be a super asset for my clients and vendors as they【Zoho CRM】サンドボックスのアップデート：メール送信トレイ機能の追加
ユーザーの皆さま、こんにちは。コミュニティチームの藤澤です。 CRMのサンドボックス（テスト環境）にメールの送信トレイ機能が追加されました。 本番環境でメール配信の前に、サンドボックスで送信される全てのメールを確認・検証できます。ワークフロー、承認プロセス、一括送信など、あらゆる送信パターンに対応しています。 「メールの送信トレイ」機能を使うと、顧客へ送信する前にメールの内容を事前確認できます。項目の欠落や書式の乱れなど、あらゆる問題をサンドボックス内でチェックできるため、本番環境でのトラブルを未然に防ぐことに役立ちます。Force mandatory entry on one of two fields on Contacts
We are finding our users aren't always entering a phone number or email address of a contact. We would like to make these fields mandatory but realize they won't always have both pieces of information, but should at least have one. Is there a way to makeHow can I prevent having recepients from being added as contacts in Zoho Desk?
How can I prevent having recepients from being automatically added as contacts in Zoho Desk? There's no option to disable this.Agent Concern
would like to ask the difference between an agent and a light agent. can a light agent close a ticket. thank you.Train Zoho Answer Bot Based on Customer
Hi all, Is it currently possible to mark Help Centre articles to a specific customer, and restrict the answer bot to only use relevant information if it is either marked as "General", or tagged for the specific customer in question? We currently haveNon-depreciating fixed asset
Hi! There are non-depreciable fixed assets (e.g. land). It would be very useful to be able to create a new type of fixed asset (within the fixed assets module) with a ‘No depreciation’ depreciation method. There is always the option of recording landErrorcode 554
Hello, I am unble to send any single email during the whole time due to the Zoho IP 136.143.188.16 being blocked by SpamCop. Please can somebody help me?Spamcop
Have been trying to email several of our clients and many of our emails keep getting bounced back with an error that states: ERROR CODE :550 - "JunkMail rejected - sender4-op-o16.zoho.com [136.143.188.16]:17694 is in an RBL: Blocked - see spamcop.net/bl.shtml?136.143.188.16"Will Zoho Search work with Zoho Learn
Currently, Zoho Search only works with Zoho Wiki which will be phased out. Moving forward, will Zoho Search be enabled for Zoho Learn? Thanks.How to use filters on all products page? Or even a category page?
Hello, I am trying to create some filters so users can use filters to find products they are looking for. So what i am trying is to create a filter according to price lets say. So if i define it this way i am expecting to see this filter option on categoryaudio and video comments in tasks in zoho projects
Hi, is it planned to have the ability to post audio and video comments? the whatsapp wechat format of communicating is a reality... tools like zoho project would facilitate a lot teamwork by facilitating the way in which we can give feedback in audio and video rather than only text. thx!Zoho Projects app update: Voice notes for Tasks and Bugs module
Hello everyone! In the latest version(v3.9.37) of the Zoho Projects Android app update, we have introduced voice notes for the Tasks and Bugs module. The voice notes can be added as an attachment or can be transcribed into text. Recording and attachingBoas práticas de desenvolvimento em Deluge
O Deluge (Data Enriched Language for the Universal Grid Environment) é a linguagem de script utilizada em diversas aplicações do ecossistema Zoho, como Zoho Creator, Zoho CRM, Zoho Books e Zoho Flow. Ela foi projetada para permitir automações rápidasSeeking a WhatsApp Business App (not API) Zoho CRM integration
We have a business need to integrated WhatsApp Business App (not API) into Zoho CRM to centrally manage communications between our Sales team and Leads & Contact. Is there a reputable integration available for this scenario of ours? Core features we wouldZoho Sign 2025–2026: What's new and what's next
Hello! Every year at Zoho Sign, we work hard to make document signing and agreement execution easy for all users. This year we sat down with our head of product, Mr. Subramanian Thayumanasamy, to discuss what we delivered in 2025 and our goals for 2026.Creditos API
Queria saber se alguém poderia me ajudar a resolver um problema na compra e utilização de créditos de mensagens API do WhatsApp. ja tentei todos o tutoriais porem não consegui realizar a compre, pois ao clicar no botão de comprar créditos aparece a mensagemIntergrating multi location Square account with Zoho Books
Hi, I have one Square account but has multiple locations. I would like to integrate that account and show aggregated sales in zoho books. How can I do that? thanks.Next Page