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 v6 of Zoho CRM. Check Versions for more details on the versions of SDK released for this API version.

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.

• 4.0.0

  • Changed phone and mobile field datatype in Users.
  • Support move_attachments_to field in the LeadConverter class.

• 2.0.0

  • Changed favorite field datatype in CustomViews.
  • Changed tabTraversal field datatype in Layouts Sections.
  • Support for the following new APIs.
    • CustomViews
      • Change Sort Order of Custom Views
    • Users
      • Users Count
    • Features
      • User Licences Count

• 1.0.0

  • Python SDK upgraded to support v6 APIs.
  • Python SDK improved to support the following new APIs
    • Unsubscribe Links
    • Find and Merge API
    • Get Related Records of Deleted Record API
    • Features API
    • Global Picklist API
    • Unblock Email API

For older versions, please refer.

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 zohocrmsdk6_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.