Sample Codes - Python SDK

Sample Codes - Python SDK

All of Zoho CRM's APIs can be used through the Python SDK, to enable your custom application to perform data sync to the best degree. Here are the sample codes for all the API methods available in our SDK.

Rest Client Operations

These methods involve authentications procedures that are to be included in your application, to provide access to Zoho CRM's data.

Methods
Description
To fetch information about your CRM account organization.
To fetch information about all modules in your CRM account.
To fetch information about the user who is currently accessing Zoho CRM's data through your application.
get_module
  To fetch information about a particular module in your CRM account.

Organization Operations

These methods involve actions that can be performed in your application, to modify the data that pertains to your Zoho CRM's organization. For instance, you can get the list of all the users (employees) that are present in your organization at any point of time.

Methods
Description
get_user
To fetch information about a specific user in your CRM account.
get_all_users
To fetch the list of all the users from your CRM account.
get_all_active_users
To fetch the list of all the active users in your CRM account.
get_all_deactive_users
To fetch the list of all the non-active users in your CRM account.
To fetch the list of all the confirmed users in your CRM account.
To fetch the list of all the users who are not confirmed in your CRM account.
To fetch the list of all the active and confirmed users in your CRM account.
To fetch the list of all the users who were deleted from your CRM account.
To fetch the list of all the users who have admin level permissions in your CRM account.
To fetch the list of all the active and confirmed users who have admin level permissions in your CRM account.
To delete a user from your CRM account.
To create a new user in your CRM account.
To update details of an existing user in your CRM account.
To fetch information on the user who is currently accessing Zoho CRM's data through your app.
To fetch the list of all the profiles that were created in your CRM account.
To fetch information about a particular profile in your CRM account.
To fetch the list of all the roles that were created in your CRM account.
To fetch information about a particular role in your CRM account.

Module Operations

These methods involve actions that can be performed in your application, to modify the data in your CRM at the module level. For instance, you can get all the records from a module, search for specific ones, delete them, and do more.

Methods
Description
get_fields
To fetch the list of all the fields that are available in a module.
get_field
To fetch information about a particular field available in a module.
get_layout
To fetch information about a particular layout of a module.
get_all_layouts
To fetch the list of all the layouts that are available for a module.
get_customview
To fetch information about a particular custom view of a module.
get_all_customviews
To fetch the list of all the custom views that are available for a module.
To fetch the list of all the related lists that are available for a module.
To fetch the information about a particular related list available for a module.
To update the settings of a module. Ex: territory, custom view, etc.
To fetch the list of all the records that are available in a module.
To create new records in a module.
To update details of multiple records in a module.
To insert/update records in a module.
To delete existing records from a module.
To update single field value for multiple records. Same value will get updated for all the mentioned records.
To fetch the list of all the records that were deleted from a module.
To fetch the list of all the records that were deleted from a module and stored in the recycle bin.
To fetch the list of all the records that were permanently deleted from a module.
To search for records in a module based on a Word(text).
search_records_by_phone
To search for records in a module based on the Phone number.
To search for records in a module based on Email address.
To search for records in a module based on a criteria specified by the user.

Record Operations

These methods involve actions that can be performed in your application, to access or modify data that are stored in a particular record. You could fetch the details of a record, create new ones, update existing ones, upload notes, attachments, photos, etc.

Methods
Description
get_record
To fetch information about a particular record.
create_record
To create a new record.
update_record
To update an existing record.
delete_record
To delete an existing records.
convert_record
To convert a record(Leads to Contacts/Deals).
get_notes
To fetch the notes that were attached to a record. 
To add a note to a record.
To update a note that was previously added to a record.
To delete a note from a record.
To fetch the list of attachments of a record.
To upload an attachment to a record.
To upload a link as an attachment to a record.
To download an attachment that was uploaded to a record.
To delete an attachment that was added to a record.
To upload a photo to a record.
To download a photo that was added to a record.
To delete a photo that was added to a record.
To make a relation between two records.
To remove a relation between two records.
get_related_records
To fetch list of records in Related Lists.





Release Notes

    • Related Articles

    • Installation - Python SDK

      The SDK can be installed for your client application through Pip. Pip is a tool for dependency management in Python. Installing Pip Please refer the document below to install pip https://pip.pypa.io/en/stable/installing/ Installing the SDK Run the ...

    • Python SDK - An Overview

      Python SDK offers a way to create client python applications that can be integrated with Zoho CRM. This SDK makes the access and use of necessary CRM APIs with ease. In other words, it serves as a wrapper for the REST APIs, making it easier to use ...

    • Sample Codes - Java SDK

      All of Zoho CRM's APIs can be used through the Java SDK, to enable your custom application to perform data sync to the best degree. Here are the sample codes for all the API methods available in our SDK. Rest Client Operations These methods involve ...

    • Sample Codes - C# SDK

      All of Zoho CRM's APIs can be used through the C# SDK, to enable your custom application to perform data sync to the best degree. Here are the sample codes for all the API methods available in our SDK. Rest Client Operations These methods involve ...

    • Responses & Exceptions - Python SDK

      APIResponse, BulkAPIResponse and FileAPIResponse are the wrapper objects for Zoho CRM APIs’ responses. All API calling methods would return one of these three objects. A method-seeking entity would return APIResponse object, whereas a method-seeking ...