Kaizen #16 - Python SDK
Hello everyone!
Welcome back to another week of Kaizen!
This week, we will discuss the Python SDK.
What is the Python SDK for Zoho CRM?
Python SDK allows you to create client Python applications that you can integrate with Zoho CRM, effortlessly. It serves as a wrapper for the REST APIs, thus making it easier to use the services of Zoho CRM.
Here is a sample of how the SDK acts as a middle ware between Zoho CRM and a client Python Application.
What can you do with the Python SDK?
- Exchange data between Zoho CRM and the client application where the CRM entities are modelled as classes.
- Authenticate your application easily every time you sync data between Zoho CRM and your application, as the SDK takes care of generating the access/refresh tokens automatically.
Environment Setup
- Client app must use Python 2.7 or above. You can download Python through https://www.python.org/downloads/
- Client app must have python requests installed. Refer to Installation of Python Requests or use the command pip install requests to install them.
How to Start using the Python SDK?
Follow the below steps:
- Step-1: Register your application (Self Client or Web-based client)
- Step-2: Install the SDK
- Step-3: Import the SDK in your project
- Step-4: Initialize the SDK
4.a. Choose the token persistence method
4.b. Setup the configuration dictionary
4.c. Generate the tokens - Step-5: Connect to Zoho CRM through the available methods
Let us now discuss these steps in detail.
Step-1: Register your application
All the Zoho CRM APIs are authenticated by the OAuth2.0 standards. It is mandatory to authenticate your application with Zoho.
You can register your application either as a Self Client (single user app) or a web-based app (multiple users app).
1.a. Self Client
- Go to https://api-console.zoho.com.
- Click ADD CLIENT.
- Choose the Client Type as Self Client, and click CREATE.
- You will receive a client ID and a client secret upon successful registration.
1.b. Web-based Client
- Go to https://api-console.zoho.com.
- Click ADD CLIENT.
- Choose the client as Web based and click CREATE NOW.
- Specify the client name, homepage URL of your application's UI, and a redirect URI to which you want to redirect the users after they grant consent to your application.
- Click CREATE.
- Your client ID and client secret will be displayed.
Step-2: Install the SDK
You can install the Python SDK through pip. Pip is a tool for dependency management in Python.
Refer to https://pip.pypa.io/en/stable/installing/ to install pip.
To install the SDK, run the below command in your Python IDE.
pip install zcrmsdk |
This command installs the Python and creates a package named zcrmsdk in the installation directory of python (Example: '/Library/Python/2.7/site-packages').
Note
You must also have the Python requests installed. Run the command pip install requests to install them.
Step-3: Import the SDK in your project
Use the below statement in your IDE to import the downloaded SDK in your code.
import zcrmsdk |
You can also set an alias for the imported SDK module. Run the below command to import the SDK in a custom name.
import zcrmsdk as your_custom_name |
Note that you must use this name while referencing to any class in the SDK.
Example:
import zcrmsdk as my_zoho_sdk my_zoho_sdk.ZCRMRestClient.initialize(config) |
Step-4: Initialize the SDK
Initializing the SDK involves the following steps.
- Step 4.a - Choosing the token persistence method
- Step 4.b - Setting up the configuration dictionary
- Step 4.c - Generating the tokens
4.a. Token Persistence
Your application should retain tokens (grant, access, and refresh tokens) to automate the process of data sync between your python application and Zoho CRM.
You can persist (store) the tokens in three ways.
- MySQL Persistence (default)
- File Persistence
- Custom DB Persistence
4.a.1. MySQL Persistence
When you want to store the tokens in the MySQL DB, run the below command to install the necessary package.
pip install mysql-connector |
In this case, you must include the following keys in the configuration dictionary (discussed in the next section), along with other mandatory keys.
"mysql_username": "root",
"mysql_password": "*****",
"mysql_port":" port_number"
Note
When you use MySQL persistence, ensure that
- MySQL runs in the same machine serving at the mentioned port (The default port is 3306.)
- There is a database named zohooauth.
- There is a table name oauthtokens with the columns useridentifier (varchar(100)), accesstoken (varchar(100)), refreshtoken (varchar(100)) and expirytime (bigint).
4.a.2. File Persistence
If you want to store the tokens in a file, you can create a file named zcrm_oauthtokens.pkl and provide the absolute path of the directory containing this file in the below key of the configuration array.
"token_persistence_path": "path_to_the_folder_containing_the pkl_file"
If you do not create this file, the SDK itself creates this file in the path you have specified, and persists the tokens there.
Note: This method is recommended only for self client apps.
4.a.3. Custom DB Persistence
To use custom DB persistence, you must
- Implement AbstractBaseClass (AbstractZohoOAuthPersistence from OAuthClient.py), and write a custom implementation of the following functions:
get_oauthtokens(user_email)
save_oauthtokens(oauthtokens)
delete_oauthtokens(user_email)
Include the following keys in the configuration dictionary, along with other mandatory keys.
"persistence_handler_class": "ClassName of the custom implementation",
"persistence_handler_path": "Absolute path of the module (.py file)"
4.b. Configuration dictionary
The below table contains the list of keys you must include in the configuration dictionary based on the type of persistence.
Mandatory keys
File Persistence | MySQL Persistence | Custom DB Persistence |
client_id | client_id | client_id |
client_secret | client_secret | client_secret |
redirect_uri | redirect_uri | redirect_uri |
token_persistence_path | mysql_username | persistence_handler_class |
-- | mysql_password | persistence_handler_path |
-- | mysql_port | -- |
currentUserEmail | currentUserEmail | currentUserEmail |
Optional keys
File Persistence | MySQL Persistence | Custom DB Persistence |
applicationLogFilePath | applicationLogFilePath | applicationLogFilePath |
sandbox | sandbox | sandbox |
access_type | access_type | access_type |
accounts_url | accounts_url | accounts_url |
apiBaseUrl | apiBaseUrl | apiBaseUrl |
apiVersion | apiVersion | apiVersion |
Where,
- client_id, client_secret, and redirect_uri - Client details you received after registering your application. For self client apps, you can pass a dummy value for the redirect uri.
- token_persistence_path - The path to store the OAuth tokens in the file. This key is mandatory if you want to use file persistence. If you include this key, this method takes precedence over other persistence methods.
- mysql_username, mysql_password, mysql_port - The MySQL username, password, and the port, respectively.
- persistence_handler_class - Name of the class of the custom implementation for persistence. This key is mandatory if you want to use custom persistence.
- persistence_handler_path - Absolute path of the module (.py file). This key is mandatory if you want to use custom persistence.
- applicationLogFilePath - The absolute path to log the exceptions during the usage of the SDK.
- sandbox - Boolean key to make API calls to the sandbox environment. The value true makes API calls to the sandbox. Default value is false.
- access_type - Must be set to offline as the SDK does not support online OAuth client, now.
- accounts_url - The domain-specific accounts URL from which you generate the tokens.For US: https://accounts.zoho.com
For EU: https://accounts.zoho.eu
For CN: https://accounts.zoho.com.cn
For IN: https://accounts.zoho.in - apiBaseUrl - The domain-specific API URL from which you make API calls. For users from domains other than the US, this key is mandatory.For US: https://www.zohoapis.com
For EU: https://www.zohoapis.eu
For CN: https://www.zohoapis.com.cn
For IN: https://www.zohoapis.in - apiVersion - Represents the version of the CRM APIs. The value is v2.
- currentUserEmail - The email ID of the current user. When you do not specify this value, the SDK throws an exception. This key is mandatory in the configuration dictionary for self-client apps.
For web-based apps, set the user Email ID in the current thread as an attribute.
threading.current_thread().setattr('current_user_email','user@email.com') |
Below is a configuration dictionary with all the keys.
config = { "apiBaseUrl":"https://www.zohoapis.com", "apiVersion":"v2", "currentUserEmail":"email@gmail.com" "sandbox":"False" "applicationLogFilePath":"", "client_id":"1000.3xxxxxxxxxxxxxxxxxxxxxxxxX0YW", "client_secret":"29xxxxxxxxxxxxxxxxxxxxxxxxxxxxx7e32", "redirect_uri":"https://www.abc.com", "accounts_url":"https://accounts.zoho.com", "token_persistence_path":"/Users/Zoho/Desktop/PycharmProjects",//For File Persistence "access_type":"offline", //Use the below keys for MySQL DB persistence "mysql_username":"", "mysql_password":"", "mysql_port":"3306", //Use the below keys for custom DB persistence "persistence_handler_class" : "Custom", "persistence_handler_path": "/Users/Zoho/Desktop/PythonSDK/CustomPersistance.py" } |
Now that you have created and registered your app with Zoho, you must authenticate it.
Pass the configuration dictionary in the method ZCRMRestClient.initialize(config) and authenticate your app.
4.c. Generating the tokens
As the V2 Zoho CRM APIs follow the OAuth2.0 protocol, it is mandatory to authorize the OAuth2.0 app before using the SDK functions with an access token.
You can generate an access token from a grant token.
You can generate the grant token in two ways based on the type of client.
For Self Client Applications
- Log in to Zoho and go to Zoho Developer Console.
- Select your Self Client.
- Provide the necessary scopes separated by commas, along with the scope aaaserver.profile.READ.
- Select the Time Duration from the drop-down. This is the time the grant token is valid for.
- Provide a description for the scopes. Click GENERATE.
- Copy the grant token.
For Web-based Applications
It is the responsibility of your client app to generate the grant token for the users trying to login.
Your Application's UI must have the Login with Zoho option to open the grant token URL of Zoho, which would prompt for the user's OAuth2.0 authorization.
Upon the successful login of the user, the grant token will be sent as a parameter to your registered redirect URL.
Generating an access token from the grant token
Use the below code snippet in your main class.
zcrmsdk.ZCRMRestClient.initialize(config) oauth_client = zcrmsdk.ZohoOAuth.get_client_instance() grant_token = "paste_grant_token_here" oauth_tokens = oauth_client.generate_access_token(grant_token) |
Note
- The code snippet to generate the access token from the grant token is valid only once per grant token. If the grant token expires before you generate the access token, you must generate a new grant token only.
- Generating access and refresh tokens is a one-time process. After the tokens are generated the first time, the SDK persists them based on the keys defined in the configuration dictionary, and refreshes the access token as and when required.
Step-5: Connect to Zoho CRM through the available methods
The below image shows the sample code to get the current user details. You can find the code for this sample in the attachment.
The below image contains the response to the above code.
We hope you found this post useful. Stay tuned for more!
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
Shylaja S
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
Zoho Desk EU slow/unresponsive
Has anyone else got issues with ZohoDesk today in the EU? It takes an age to come back and if you do start typing something and try and send or save it looks like it times out. We are also getting this pic. ot I can't see anything on https://status.zoho.eu/EU DC Partial Outage Resolved: A Detailed RCA
Incident Summary Due to an overload on one of the nodes in the EU DC for Zoho Desk, the system was unable to handle the heavy load, causing a slowdown in requests and resulting in a partial outage for customers with data residing in that node. On MayPerfomance Management - Zoho People
Hi team, I am looking for performance management data such as KRA, goals, feedback, appraisals, etc., in Zoho Analytics. However, I am unable to find these metrics while editing the setup. Could you please confirm whether these fields are available inDeprecation of the Zoho OAuth connector
Hello everyone, At Zoho, we continuously evaluate our integrations to ensure they meet the highest standards of security, reliability, and compliance. As part of these ongoing efforts, we've made the decision to deprecate the Zoho OAuth default connectorZoho Mail iOS app update: Display recipient's nickname on contact suggestion
Hello everyone! In the most recent version(v3.3.1) of the Zoho Mail iOS app update we have brought in support to display recipient's nickname in contacts suggestion. Please update the app to the latest version directly from the App Store or using theDigest Février - Un résumé de ce qui s'est passé le mois dernier sur Community
Bonjour chers utilisateurs, Le 26 février, nous avons organisé notre première session Ask the Expert de 2026. Nous sommes heureux de partager que ce fut une session très interactive, avec de nombreuses questions intéressantes posées par nos clients. SiZoho CRM Case Notes - Share to Customer
Hi team does anyone know the Api to set a note, against a case, to shared with customer? i cant seem to find it cheersSend out follow-up email in the same thread (threaded conversations in individual emails) from Zoho CRM
Hi, I'm new to Zoho. I'm trying to send individual emails to my leads one by one. And I'll send out follow up email if I don't hear back from them later. However, instead of sending a new email, I want to reply in the same email thread so that the recipientsDepositing funds to account
Hello, I have been using Quickbooks for many years but am considering moving to Zoho Books so I am currently running through various workflows and am working on the Invoicing aspect. In QB, the process is to create an invoice, receive payment and thenweb to lead
Can anyone help me how to create web to lead from zoho marketing automationHow can I see content of system generated mails from zBooks?
System generated mails for offers or invices appear in the mail tab of the designated customer. How can I view the content? It also doesn't appear in zMail sent folder.UI issue with Organize Tabs
When looking at the organize Tabs window (bellow) you can see that some tabs are grayed out. there is also a "Add Module/Web Tab" button. When looking at this screen it's clear that the grayed out tabs can not be removed from the portal user's screenI created a signup form in Zoho Marketing Automation with the correct field mapping, but the data is not being reflected under Leads in Zoho CRM.
web to lead from zoho marketing automationPasted Images not being embedded in custom mail
Hi, I'm making a custom report by email based on commentaries. I have the email ready, all working great except for images that are being pasted in the commentaries. Zoho deals with them as temp images and so it requires authentication to view them, somethingKaizen #232 - Building a Ticket Escalation Mechanism from Zoho CRM
Howdy, Tech Wizards! Picking up the thread from last week, we will continue our Zoho CRM and Zoho Desk integration. In Kaizen #231 - Embedding Zoho Desk Tickets in Zoho CRM, we built a Related List widget that displays open Zoho Desk tickets within theInactive License for free account.
I recently upgraded my Cliq subscription not my team (on the free version), are unable to login to their accounts. The error message received is Inactive License Looks like you have not been covered under the current free plan of users. Please contactDeluge scripts
Why is there not a search function to make it easier to find the script of interest when modifications are required.Zoho Sheet for Desktop
Does Zoho plans to develop a Desktop version of Sheet that installs on the computer like was done with Writer?Searching for an item from within an invoice should show any item containing the string, not just those that begin with the string.
Hello, I've found myself becoming increasingly frustrated with the limited line-item seach when adding new items to an invoice. The problem is that the characters being typed are only being matched from the beginning of the item name. This might be usableHow to Rank Tables by Row Count in Descending Order
I am trying to understand the consume of lines that grow up so fast in the last week. Is there any way to create a pivot table or query to get TABLE NAME LINES in descending order?Dealing With One-Time Customers on Zoho Books
Hello there! I am trying to figure out a way to handle One-Time customers without having to create multiple accounts for every single one on Zoho Books. I understand that I can create a placeholder account called "Walk-In Customer", for example, but IFeature Request: Render Markdown (.md) files in Zoho Cliq
Hi, We regularly share Markdown (.md) files in Zoho Cliq. However, when we open these files in Cliq, the content does not render as Markdown—it displays as plain text. This forces us to copy/paste the content into an external Markdown viewer to read itCRM Percent custom fields: When will it show the % symbol and behave like %?
1. Actually Percent custom fields fail to show the % symbol. 2. When in formulas Percent fields work like number: 100 x 5% = 5 ideal world 100 x 5% = 500 what happens actually 3. When importing Percent fields the % symbol has to be removed and the dataSubforms and automation
If a user updates a field how do we create an automation etc. We have a field for returned parts and i want to get an email when that field is ticked. How please as Zoho tells me no automation on subforms. The Reason- Why having waited for ever for FSMXero Billing Data (22 instances) - Zoho (CRM) - Single Source of Truth For Client Data & Notes
Hi - I’m trying to build out a CRM for a Single Source of Truth Currently I have 22 Instances of Xero (for legal entity purposes - can’t consolidate to one) How would I be best placed to do this? Is it possible to have all the Xero instances (22) → ConsolidatedZoho CRM Quotes – Subform and PDF/Writer Limitations
Hello, I am encountering the following limitations in Zoho CRM Quotes: Custom product images cannot be uploaded in the subform – the image upload field cannot be added; only the file upload field is available. File upload placeholders cannot be used inStrange behavior in CRM Number Field – Characters allowed but not "e"?
Hi everyone, Has anyone faced this strange issue in Zoho CRM? In a Number field, it is possible to type some characters, but the character "e" cannot be entered. This was really surprising to me. Normally, a number field should restrict all charactersNo background for video recordings, no playback speed, can't even playback longer recordings - have to download…
Hi. We utilize heavily video messages on Slack, but wanted to migrate to Cliq with Zoho One, however very basic yet very frequently used feature is missing: backgrounds for video recordings and playback speed. We were not happy with Slack's 5 minute limitsSupport inefficiency
We have been asking for support for a minor adjustment for 12 days now and we haven't got a single viable resolution from support team despite there are 19 emails going between our HR team and various support emails from Zoho. 1. they do not understandAbout Certification Exam
I recently written Zoho Creator Ceritification Exam But i failed in first attempt of exam. how to reset my account for second attempt of exam .Zia capabilities now available in the Professional edition announcement
Hello all! The Professional edition now supports a broader set of Zia capabilities, enabling teams to bring AI into more of their everyday CRM work. From writing assistance and summaries to setup support, predictions, and recommendations, Zia can nowWhere Do I set 24h time format in Cliq?
Where Do I set 24h time format? ThanksHow to I generate Proforma Invoices?
When customers need to pay by bank transfer I need to send them a Proforma Invoice with our bank details. I am unable to work out how this can be done. It needs to be done at the Sales Order stage before a formal Invoice is generated. John Legg Owner:Can I Integrate ADP Payroll with Zoho Books?
Hi, I am hoping that I can integrate ADP Payroll with Zoho Books so that I do not need to manually input the payroll journal entries. Is this possible? If so, how do I do that?This will be long, Please bear with me - Next Gen Layout - Search
In general, I think that Zoho are going in the right direction with the Next Gen UI. The latest update brings some nice improvements and all-in-all from a user's perspective I think the improvements are generally very good. However, there are some areasSelecting all notes in a notebook
In Windows11, I select a notebook and I get a list of notes, but only 30 notes. If I scroll down to the end, I get an additional 30 notes (and at the top it now shows 60 notes). I can keep doing this to eventually see all my notes but this is a real pain.Filter Records in CRM API
Hi Team, I’m currently working on a task to retrieve expired deals from the CRM. By “expired deals,” I mean deals where the closing date has already passed and the stage is not “Closed Won” or “Closed Lost” (i.e., all other stages). I tried using bothUser Name in Zoho Cliq Not Updating Across Apps?
We updated the name of a user in Zoho. (From Sue to Taylor) Her name has not been updated in Cliq on all apps. When in Zoho One, if I go to Cliq directly, it is correct, but if I am in another app, and the Cliq bar pops up on the bottom, it will be theWhy I can't map Account Name from lead module to Account module?
When I qualify a lead in the bluerprint, I use automated conversion in Blueprint to automatically create Contact, Account and Deal. the Deal record and contact record has been successfully created automatically as I expect, but I can't see any accountPause(1);
I'm using scheduler to invoke an interaction via http post with an external service. The schedule code uses a for-each loop that runs so fast my external application's log files get messed-up (they are named by date-time stamp). What I'm suggesting isNext Page