ZOHO CRM PYTHON SDK 8.0 for API version 8

The Python SDK for Zoho CRM allows developers to easily create Python applications that can be integrated with Zoho CRM. This SDK serves as a wrapper for the REST APIs, making it easier to access and utilize the services of Zoho CRM. Authentication to access the CRM APIs is done through OAuth2.0, and the authentication process is streamlined through the use of the Python SDK. The grant and access/refresh tokens are generated and managed within the SDK code, eliminating the need for manual handling during data synchronization between Zoho CRM and the client application.

This repository includes the Python SDK for API v8 of Zoho CRM. Check Versions for more details on the versions of SDK released for this API version.

License

Copyright (c) 2021, ZOHO CORPORATION PRIVATE LIMITED 
All rights reserved. 

Licensed under the Apache License, Version 2.0 (the "License"); 
you may not use this file except in compliance with the License. 
You may obtain a copy of the License at 

    http://www.apache.org/licenses/LICENSE-2.0 

Unless required by applicable law or agreed to in writing, software 
distributed under the License is distributed on an "AS IS" BASIS, 
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
See the License for the specific language governing permissions and 
limitations under the License.

Latest Version

• 5.0.0

• Updated dependencies in setup.py and requirements.txt files.

• Handled SDK utils.

• Improved DB store query handling.

• Fixed an issue with the Blueprint update API response.

• Blueprint Field class validationRule field datatype changed (String to Object).

• BulkWrite BodyWrapper class fileType field datatype changed (Choice to String).

• BulkWrite JobDetail class fileType field datatype changed (Choice to String).

• BulkRead Query class fileType field datatype changed (Choice to String).

• Modules GetModulesParam class STATUS field datatype changed (Choice to String).

• Added new trigger field in Notes BodyWrapper class.

• Notifications class deleteEvents field datatype changed (Choice to String).

• Modules DeleteNotificationParam class CHANNEL_IDS field datatype changed (Long to String).

• Profiles and MinifiedProfile class delete field datatype changed (Boolean to Delete class).

• Added new applyFeatureExecution, applyValidationRule, applyFunctionValidationRule, and skipFeatureExecution fields in Record BodyWrapper class.

• Tags class colorCode field datatype changed (Choice to String).

• Users CountWrapper class count field datatype changed (Long to Integer).

• Users GetUsersParam class TYPE field datatype changed (Choice to String).

• Webforms Abtesting class id field datatype changed (Long to String).

• Webforms AcknowledgeVisitor class templateId field datatype changed (Long to String).

• Webforms AssignmentRule class id field datatype changed (Long to String).

• Webforms Layout class id field datatype changed (Long to String).

• Webforms Module class id field datatype changed (Long to String).

• Webforms Owner class id field datatype changed (Long to String).

• Webforms Tags class id field datatype changed (Long to String).

• Webforms Users class id field datatype changed (Long to String).

• Webforms Users acknowledgeVisitor field datatype changed (AcknowledgeVisitors to AcknowledgeVisitor).

• Removed updateWebForms method from the WebformsOperations class.

• 4.0.0

  • Added mysql-connector-python as an optional dependency via extras_require in setup.py.
  • Users who require MySQL support can now install it using pip install zohocrmsdk8-0[mysql]

• 3.0.0

  • trigger field has been added to the Notes API.
  • Improved Multi-User Initialization Handling in Initializer Class.

• 2.0.0

  • New fields have been added to the History Tracking Fields API.
  • Fixed the issue with the inventory mass conversion status API.

• 1.0.0

  • Python SDK upgraded to support v8 APIs.

  • Python SDK improved to support the following new APIs

    • Get Related Records Count of a Record
    • Calls Preference
    • Record-Level Sharing of Emails
    • Data Sharing Rules API
    • Get Rich Text Fields API

For older versions, please refer.

Including the SDK in your project

You can include the SDK to your project using:

• For including the latest version

  • Install Python from python.org (if not installed).

  • Install Python SDK

    • Navigate to the workspace of your client app.
    • Run the command below:

    pip install zohocrmsdk8_0

  • The Python SDK will be installed in your client application.

NOTE

• The access and refresh tokens are environment-specific and domain-specific. When you handle various environments and domains such as Production, Sandbox, or Developer and IN, CN, US, EU, JP, or AU, respectively, you must use the access token and refresh token generated only in those respective environments and domains. The SDK throws an error, otherwise. For example, if you generate the tokens for your Sandbox environment in the CN domain, you must use only those tokens for that domain and environment. You cannot use the tokens generated for a different environment or a domain.

• For Deal Contact Roles API and Records API, you will need to provide the ZohoCRM.settings.fields.ALL scope along with the ZohoCRM.modules.ALL scope while generating the OAuthtoken. Otherwise, the system returns the OAUTH-SCOPE-MISMATCH error.

• For Related Records API, the scopes required for generating OAuthtoken are ZohoCRM.modules.ALL, ZohoCRM.settings.fields.ALL and ZohoCRM.settings.related_lists.ALL. Otherwise, the system returns the OAUTH-SCOPE-MISMATCH error.

• For Mass Convert API, you will need to provide the ZohoCRM.settings.fields.ALL scope along with the ZohoCRM.mass_convert.leads.CREATE and ZohoCRM.mass_convert.leads.READ scope while generating the OAuthtoken. Otherwise, the system returns the OAUTH-SCOPE-MISMATCH error.

---

For more details, kindly refer here.