Kaizen #51 - Handling Users with ZohoCRM API

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








                      Zoho Campaigns Resources




                            Zoho Developer Community



                                Bootcamp
                                Community
                                Pricing
                                Webinars
                                What's New
                                Integrations
                                Contact Support
                                Contact Sales
                                  Zoho Survey Resources
                                    Features
                                    Survey Templates
                                    Integrations
                                    Community
                                    iOS Mobile Surveys
                                    Pricing
                                    Android Mobile Surveys
                                    Insurvey Blogs
                                    Insight Blogs
                                    Tips & Tricks






                                                Latest Feature Updates

                                                  • Desk Community Learning Series


                                                  • Digest


                                                  • Functions


                                                  • Meetups


                                                  • Kbase


                                                  • Resources


                                                  • Glossary


                                                  • Desk Marketplace


                                                  • MVP Corner


                                                  • Word of the Day


                                                  • Ask the Experts




                                                      Zoho SalesIQ Resources


                                                            Manage your brands on social media
                                                            Access Zoho Social

                                                              Zoho Pagesense Resources


                                                                  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 CRM Resources

                                                                                      • CRM Community Learning Series

                                                                                        CRM Community Learning Series


                                                                                      • Kaizen

                                                                                        Kaizen

                                                                                      • Functions

                                                                                        Functions

                                                                                      • Meetups

                                                                                        Meetups

                                                                                      • Kbase

                                                                                        Kbase

                                                                                      • Resources

                                                                                        Resources

                                                                                      • Digest

                                                                                        Digest

                                                                                      • CRM Marketplace

                                                                                        CRM Marketplace

                                                                                      • MVP Corner

                                                                                        MVP Corner







                                                                                          Design. Discuss. Deliver.

                                                                                          Create visually engaging stories with Zoho Show.

                                                                                          Get Started Now


                                                                                            Zoho Show Resources


                                                                                              Zoho Writer Writer

                                                                                              Get Started. Write Away!

                                                                                              Writer is a powerful online word processor, designed for collaborative work.

                                                                                                Zoho CRM コンテンツ




                                                                                                  Nederlandse Hulpbronnen


                                                                                                      ご検討中の方




                                                                                                            • Recent Topics

                                                                                                            • Zoho Desk: No Incoming email

                                                                                                              Is Zoho Desk services down? No incoming email reflect to desk tickets.

                                                                                                            • Issue connecting Zoho Mail to Thunderbird (IMAP/SMTP authentication error)

                                                                                                              Dear Zoho Support, I am trying to configure my Zoho Mail account on Thunderbird, but I keep getting authentication errors. Account: info@baktradingtn.com Domain: baktradingtn.com Settings used: IMAP: imap.zoho.com, Port 993, SSL/TLS, Normal Password SMTP:

                                                                                                            • Payment issue with Mail Lite plan – personal NIF not accepted as payment info

                                                                                                              Hello, I have already contacted Zoho Support by email regarding this, but since I haven’t received any reply yet, I’m sharing it here as well to see if the community can help. I’m facing a payment issue for my Mail Lite plan. I have a personal account

                                                                                                            • Customer payment alerts in Zoho Cliq

                                                                                                              For businesses that depend on cash flow, payment updates are essential for operational decision-making and go beyond simple accounting entries. The sales team needs to be notified when invoices are cleared so that upcoming orders can be released. In contrast,

                                                                                                            • {"code":1038,"message":"JSON is not well formed"}

                                                                                                              Today this began failing: sales_order_data = zoho.books.createRecord("salesorders",books_organization_ID,order_data); with this error message. {"code":1038,"message":"JSON is not well formed"} This code has been running for two years. Here is the input

                                                                                                            • In arattai received message can't be deleted

                                                                                                              The issue has been noticed in following: arattai app (Android) arattai app (Window) arattai web While the message posted by me may be deleted, the ones received from others can't be. The item <Delete> change to <Report> when the message is a received

                                                                                                            • Zoho Editor

                                                                                                              Zoho PDf Editor is not working I am clicking on EDIT PDf then it again bringing me back to the same page. again and again.

                                                                                                            • Figma in Zoho Creator

                                                                                                              Hi Team, I’m creating a form using Figma and would like to know how to add workflows like scheduling, custom validation, and other logic to it. Can anyone help me understand how to set this up for a Figma-based Creator UI form?

                                                                                                            • Zoho sheet for desktop

                                                                                                              Hi is zoho sheets available for desktop version for windows

                                                                                                            • How to Delete Personal Account Linked with My Mobile Number in past or by someone else

                                                                                                              How to Delete Account Created with My Mobile Number in past or by someone else This is creating issues in making or sync with my credentials mobile and email address..

                                                                                                            • Connecting two modules - phone number

                                                                                                              Hi, I’d like some guidance on setting up an automation in Zoho CRM that links records between the Leads module and a custom module called Customer_Records whenever the phone numbers match. Here’s what I’m trying to achieve: When a new Lead is created

                                                                                                            • Enable / show scroll bar when Mega Menu is opened

                                                                                                              Hey there I am using the mega menu add-on and experience a "flicker" whenever the mega menu opens. The reason is, that the scrollbar, which has a width of a few pixels, stops showing when the mega menu opens. As the scrollbar disappears the whole page

                                                                                                            • Restore lost Invoice!

                                                                                                              Some time ago I tried to Upgrade from Invoice to Books. I not upgraded and staid n Invoice. Now i tried again and first i deleted the old trial of books. But now all is gone, PLEASE HELP!! i have no backup and i have to have at least 7 years data retention by law. 

                                                                                                            • Kaizen# 209 - Answering Your Questions | All About Client Script

                                                                                                              Hello everyone! Welcome back to another exciting Kaizen post! Thanks for all your feedback and questions. In this post, let's see the answers to your questions related to Client Script. We took the time to discuss with our development team, carefully

                                                                                                            • Zoho Desk Down

                                                                                                              Not loading

                                                                                                            • Has anyone integrated SMS well for Zoho Desk?

                                                                                                              Our company does property management and needs to be able to handle inbound sms messages which create a ticket for Zoho Desk. We then need to be able to reply back from Zoho desk which sends the user an sms message. This seems like a fairly common thing

                                                                                                            • lookup and integrated forms

                                                                                                              I might be misunderstanding things but I wanted to integrate our zoho crm contacts into creator. I imagined that when I used the integration it would mirror into creator. It did brilliant. BUT We have a ticket form in creator that we want to use a lookup

                                                                                                            • Create custom rollup summary fields in Zoho CRM

                                                                                                              Hello everyone, In Zoho CRM, rollup summary fields have been essential tools for summarizing data across related records and enabling users to gain quick insights without having to jump across modules. Previously, only predefined summary functions were

                                                                                                            • Partially receive PO without partial Bill?

                                                                                                              Most of our inventory is pre-paid. Let's say we purchase 30 pieces of 3 different items for a total of 90 pieces. It is common for our supplier to send us the items as they are ready. So we will receive 30 pieces at a time. How can I partially receive

                                                                                                            • 2 users editing the same record - loose changes

                                                                                                              Hello, I'm very new to Zoho so apology if this has been addressed somewhere i can't find. I have noticed the following: If we have 2 users put an inventory item in edit mode at the same time: say user1 click on edit and user2 while user1 is still in edit,

                                                                                                            • How to get the Dashboard page to be the first page when you open the app

                                                                                                              So when it opens on a tablet or phone it opens on the welcome page, thanks.

                                                                                                            • How I set default email addresses for Sales Orders and Invoices

                                                                                                              I have customers that have different departments that handle Sales Orders and Invoices. How can i set a default email for Sales Orders that's different than the default email for Invoices? Is there a way I can automate this using the Contact Persons Departments

                                                                                                            • Cliq iOS can't see shared screen

                                                                                                              Hello, I had this morning a video call with a colleague. She is using Cliq Desktop MacOS and wanted to share her screen with me. I'm on iPad. I noticed, while she shared her screen, I could only see her video, but not the shared screen... Does Cliq iOS is able to display shared screen, or is it somewhere else to be found ? Regards

                                                                                                            • Adding hyperlinks in CRM emails time automatically

                                                                                                              It may just be me, but when I am writing an email to a lead, I find inserting a hyperlink very time consuming. Granted, I can use templates but there are a ton of scenarios where I might want to put a link in to an website that wouldnt require me to go though the effort of creating a template.  Ideally, the crm would identify that I that a string of text is a URL and insert the hyperlink automatically, just like microsoft outlook or gmail. Has anyone else had this same experience and found a way

                                                                                                            • Notes Attachments

                                                                                                              Two things it would be nice to have the attachment size the same as the attachments sections and it would be nice to be able to attach links like you can in the attachments section. Thank you

                                                                                                            • Zoho Sheet - Desktop App or Offline

                                                                                                              Since Zoho Docs is now available as a desktop app and offline, when is a realistic ETA for Sheet to have the same functionality?I am surprised this was not laucned at the same time as Docs.

                                                                                                            • Formula fields not refreshing until page is reloaded

                                                                                                              I need help/advice about the formula fields and how I can refresh the information in real-time. We have two formula fields on our deals page which show calculated prices: One formula is in a subform which calculates the subform total + 1 other field amount

                                                                                                            • Search in Zoho Community Not Working

                                                                                                              I realize this is a bit of a meta topic, but the search for the various Zoho Communities appears to not be working. I'm under the impression that they run on some version of the Zoho Desk platform, so I'm posting this here.

                                                                                                            • Enhancements to finance suite integrations

                                                                                                              Update: Based on your feedback, we’ve updated the capabilities for integration users. In addition to the Estimates module, they can now create, view, and edit records in all the finance modules including Sales Order, Invoices, Purchase Order. We're also

                                                                                                            • How can I setup Zoho MCP with Chat GPT

                                                                                                              I can set up custom connections with Chat GPT but I cat an error when I try to set it up. The error is: "This MCP server can't be used by ChatGPT to search information because it doesn't implement our specification: search action not found" Thoughts?

                                                                                                            • Update a field in ALL all calls under a contact

                                                                                                              HI guys! I have written some deluge code to update a field in my calls after i have comepleted the call, i need this field to update in all my scheduled calls as well that are comeing up. I just cant seem to get it to work, i have put teh code below,

                                                                                                            • Export 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 opportunities

                                                                                                            • API ZOHO CRM Picket list with wrong values

                                                                                                              I am using Zoho API v.8. with python to create records in a custom module named "Veranstaltung" in this custom module I've got a picket list called "Email_Template" with 28 Values. I've added 8 new values yesterday, but if I try to use on of those values

                                                                                                            • Group Emails

                                                                                                              I have synced Zoho CRM to Campaigns but there are certain email not synced. showing it is Group Emails, but this email ids belongs to different individuals. please provide a solution as i nedd to sync the same.

                                                                                                            • "Is Zoho CRM customer" vs "Is linked with Zoho CRM"

                                                                                                              Recently while building a Flow, I was setting up a Decision action following a Zoho Invoice Fetch record action. There were 2 choices that I had not seen as something I could manually action in Zoho Invoice: "Is Zoho CRM customer" and "Is linked with

                                                                                                            • Client Script | Update #13 - Introducing ZRC: Simplified HTTP request library

                                                                                                              Hello Developers! Are you tired of juggling different methods to make API calls? Are you confused with multiple syntaxes and version restrictions? Have you ever wished for one simple way to make all API calls in CRM? We heard you :) Here comes ZRC (Zoho

                                                                                                            • Selection Filed for Data Export section

                                                                                                              Hi FSM Team, I hope you are all doing well. I would like to share an idea for future development based on my experience. Currently, in FSM, we can only download up to 5,000 records at a time. If the development team could add a selection option to choose

                                                                                                            • Text wrap column headers in reports?

                                                                                                              Is it possible to auto wrap column headers so that a longer multi-word header displays as two lines when the column is narrower than the width of the header title?

                                                                                                            • What if I dont see contacts on the left side list

                                                                                                              My CRM does not show the contacts tab. In order to create list this is needed and I cant find it.

                                                                                                            • Comments Vs. Replies

                                                                                                              I'm curious as to the difference between a "Reply" and a "Comment" on a ticket. It appears that "Replies" are what's used to determine response time SLA's and there are also used to automatically re-open tickets. I'm just trying to understand the key differences so I can educate both our clientele and our back-end users on which function/feature to use to better improve the ticket lifecycle. If anyone has any insight it would be appreciated. Thanks!

                                                                                                            • Next Page