API Methods

API Methods

API Methods
Method Name
Purpose
getMyRecords 
To retrieve data by the owner of the Authentication Token specified in the API request
getRecords 
To retrieve all users data specified in the API request
getRecordById 
To retrieve individual records by record ID
insertRecords 
To insert records into the required Zoho CRM module
updateRecords 
To update or modify the records in Zoho CRM
getSearchRecordsByPDC 
To search the values based on pre-defined columns
getCustomViews 
To retrieve the list of custom views in a module
deleteRecords 
To delete the selected records
convertLead 
To convert lead to potential, account and contact
getRelatedRecords 
To retrieve records related to a primary module
getFields 
To retrieve details of fields available in a module
updateRelatedRecords 
To update records related to another record
getUsers 
To retrieve the list of users in your organization
uploadFile 
To attach a file to a record
delink 
To disassociate the relationship between parent and child records
downloadFile 
To download a file attached to a record
deleteFile 
To delete a file attached to a record
uploadPhoto 
To add a photo to a contact or lead
downloadPhoto 
To download the photo of a contact or lead
deletePhoto 
To delete a photo of a contact or lead
getModules 
To retrieve all modules from Zoho CRM account
searchRecords 
To retrieve the records that match your search criteria

    • Related Articles

    • API Limits

      API Limits The Zoho CRM Platform API is available in all editions of Zoho CRM. To use the API, you'll require the Authentication Token from your CRM account. Please make sure that you have the permission to access the API service. If you do not have ...

    • Setting Up Nonprofit Vertical CRM

      Setting up Nonprofit Vertical CRM for your Organization The Setup page in Nonprofit Vertical CRM helps you configure all settings necessary to get your CRM up and running. Be it personalization, automation or third-party integrations, you can ...

    • Checking Duplicate Records in Nonprofit Vertical CRM

      When you have hundreds and thousands of records in your CRM, as your business grows, it becomes a very difficult task to check for duplicates. Nonprofit Vertical CRM helps you arrest duplicates even before they can be created, with the help of what ...

    • Examples

      1. Fetch Records from the "Leads" Module  Programming Language JAVA  Prerequisite JDK 1.6 commons-httpclient-3.1.jar   Code Snippet import org.apache.commons.httpclient.*; import org.apache.commons.httpclient.methods.*; public class GetRecords {     ...

    • Error Messages

      Error Messages Error Code Description 4000 Please use Authtoken, instead of API ticket and APIkey. 4500 Internal server error while processing this request 4501 API Key is inactive 4502 This module is not supported in your edition 4401 Mandatory ...