APIs and References
Metadata APIs
Metadata of fields, modules, layouts, related lists, etc,.
Customization
Modules
Perform CRUD operations on the modules of your organization.
- Get Modules - Retrieve the list of all the modules available in your CRM account.
- Get a Specific Module - Get the metadata for a specific module.
- Create a Custom Module - Create a new custom module in Zoho CRM.
- Update a Custom Module - Update a custom module in Zoho CRM.
Fields
Perform CRUD operations on the fields of various modules.
- Get Fields - Get the metadata of fields of a module such as the labels, API name, data type etc,.
- Create Custom Fields - Create custom fields in a module.
- Update Custom Fields - Update custom fields in a module.
- Delete a Custom Field - Delete a custom field from a module.
- Get Picklist Values - Fetch detailed information about the values in a picklist field, such as display value, reference value, color code, actual value, ID, type, and associated layouts within a specific module.
Layouts
Get the details of various layouts and perform CRUD operations on custom layouts.
- Get Layouts - Get details of the layouts associated with a particular module.
- Activate Custom Layout - Activate a previously deactivated custom layout.
- Deactivate Custom Layout - Deactivate a custom layout.
- Deactivate Custom Layout - Deactivate a custom layout.
- Update Custom Layout - Update a custom layout.
- Delete Custom Layout - Delete a custom layout from a module.
Related Lists
Get the details of the related lists in a particular module.
- Get Related List Metadata - Get the details of the related lists in a particular module.
Custom View
Get the details of custom views created for a module.
- Get Custom View Metadata - Get the metadata of a custom view of a particular module.
- Change Sort Order of a Custom View - Change the sort order of records in a custom view.
Templates
Get the details of inventory and email templates created for your organization.
- Get Inventory Templates - Fetch the details of inventory templates.
- Email Templates - Fetch the email templates in a module.
Duplicate Check Option
Set up criteria using unique fields to manage duplicates across Leads module including Converted Leads and Contacts in Zoho CRM.
- Enable Duplicate Check Option - Enable the Duplicate Check Preference in the Leads module.
- Get Duplicate Check Option - Retrieve the Duplicate Check Preference Options configured in your account.
- Update Duplicate Check Option - Update the previously enabled Duplicate Check Option configured in your account.
- Disable Duplicate Check Option - Disable the Duplicate Check Preference option.
Tags
Perform CRUD and other operations on the tags in Zoho CRM.
- Get Tag List - Display all the tags in your organization.
- Add Tags - Add tags to records.
- Update Tags - Update tags and their color codes.
- Delete Tag - Delete a tag from a module.
- Merge Tag - Merge tags and put all the records under the two tags in to a single tag.
- Add Tags to Record(s) - Add tags to records.
- Remove Tags from Record(s) - Delete the tags associated with records.
- Record Count of a Tag - Get the total number of records under a tag.
- Mass Delete Tags - Delete tags in bulk from a module.
- Mass Delete Tags Status - Get the status of a previously scheduled mass tags deletion job using the Mass Delete Tags API.
Wizards
Wizards divide long forms into screens, and reduce the chances of errors during data entry as the screens can be partially saved as a draft and submitted later.
- Get Wizards - Get the details of the wizards in a module.
Record Locking Configuration
Set up the configuration needed to lock the records in modules manually or automatically when certain conditions are met.
- Get Record Locking Configuration - Retrieve the record locking configuration for different modules.
- Add Record Locking Configuration - Add record locking configuration for different modules.
- Update Record Locking Configuration - Update the record locking configuration for different modules.
- Delete Record Locking Configuration - Delete the record locking configuration for different modules.
Map Dependency
There are certain fields in a module whose values depend on another field's value. This can be defined as a parent-child relationship. Define the values that are applicable to a child field based on the parent field's value using these APIs.
- Get Mapped Dependency Fields - Get the details of the parent and child fields configured for a module.
- Map Dependency - Map dependency fields on a layout of the module in Zoho CRM.
- Update Mapped Dependency Fields - Update map dependency fields on a layout of the module.
- Delete Mapped Dependency - Delete the dependency mapped for the picklist fields on a layout of the module.
Global Picklists
Global sets or global picklists are used to manage picklist values that are common across modules. Perform CRUD operations and more on global picklists with these APIs.
- Get Global Picklists - Retrieve the details of global picklists configured in your Zoho CRM account.
- Create Global Picklist - Create a global set or a global picklist.
- Update Global Picklist - Update a global picklist or a global set.
- Delete Global Picklist - Delete a global picklist configured in your Zoho CRM account.
- Replace Global PickList Value - Replace a picklist value from all the used places, with another existing option of the global picklist.
- Get Global Picklist option replace job status - Get the status of a scheduled picklist option replacement job initiated through the replace picklist value API.
- Get Global Picklists Features Association - Get details of the features where a specific option of a global picklist is associated, like workflows or blueprints.
- Get Global Picklist Field Associations - Retrieve information on the fields, modules, and layouts where a global picklist is associated
Unsubscribe Links
Allow the customers to unsubscribe from your email communications by creating an unsubscribe link and embedding it in the emails or hosting on the web pages. You can use the system defined default link or create a custom link. The default unsubscribe link will be available for all users and that cannot be customized. Achieve this using the following APIs.
- Get Unsubscribe Links - Fetch the details of unsubscribe links set up in your CRM account.
- Create Unsubscribe Link - Create an unsubscribe link, which can be used in your email templates or email footers.
- Update Unsubscribe Link - Update an unsubscribe link.
- Delete Unsubscribe Link - Delete an unsubscribe link.
- Get Unsubscribe Link Associations - Obtain information regarding the associations of unsubscribe links configured in your account.
Calls Preferences
Enable/Disable the "From Number" and "To Number" preferences to add the "From Number" and/remove "ToNumber" fields to the Calls module, respectively. Use the following APIs to retrieve and update the Calls Preferences details in the Calls module of your Zoho CRM organization.
- Get Calls Preferences - Retrieve the Calls Preferences details in the Calls module of your Zoho CRM organization.
- Update Calls Preferences - Enable or disable the Calls Preferences in the Calls module in your Zoho CRM organization.
Process Automation
Blueprint
A Blueprint captures every detail of your entire offline process within the software. It facilitates automation, validation, and collaboration of teams, thus making your process more efficient and free from loopholes. Use these APIs to fetch and update the details of a blueprint.
- Get Blueprint Data - Get the next available transitions for a record, fields available for each transition, current value of each field, and their validation (if any).
- Update Blueprint Details - Update a single transition at a time.
Pipeline
Perform CRUD operations on a pipeline of the Deals module.
- Get Pipelines - Fetch the details of all or a specific pipeline in the Deals module.
- Create Pipeline - Create a pipeline with various stages that a deal passes through.
- Update Pipeline - Update a pipeline in a layout.
- Transfer and Delete a Pipeline - Delete a pipeline and transfer the associated stages to another pipeline.
Assignment Rules
Get the details of the assignment rules configured for your organization.
- Get Assignment Rules - Fetch the assignment rules in your organization.
Related Lists
Get the details of the related lists in a particular module.
- Get Related List Metadata - Get the details of the related lists in a particular module.
Cadences
Cadences in Zoho CRM automates and streamlines customer follow-up processes. It enables you to create targeted, sequential communications, like emails, calls, or tasks, based on customer interactions and behaviours. Get the details of cadences, enroll and unenroll records from cadences using these APIs.
- Get Cadences - Get the details of cadences configured in your org.
- Enroll Records In Cadences - Manually enroll the records of a module in a Cadence.
- Un-enroll Records from Cadences - Manually un-enroll the records of a module from a Cadence.
Scoring Rules
Zoho CRM provides a system for ranking different records in a module governed by rules that you define based on your specific needs. A record's score is a value calculated based on the rules. With this feature, the system assists you in locating the most valuable records. Perform CRUD operations and more on Scoring Rules using these APIs.
- Get Scoring Rules - Get the list of scoring rules defined for the organization.
- Create Scoring Rules - Create a scoring rule for a module in the organization.
- Update Scoring Rules - Update a scoring rule.
- Delete Scoring Rules - Delete scoring rules.
- Execute Scoring Rules - Execute scoring rules for a module in the organization.
- Get Entity Scores - Get the entity score of a record.
- Update Scoring Rule Status - Activate or deactivate a scoring rule.
- Clone Scoring Rule - Clone a scoring rule.
Security Control
Roles
Roles, such as Managers, Sales Reps, Supervisors, Product Management Staff, etc., denote the different levels of employees in a company. Use these APIs to perform CRUD operations on various roles in Zoho CRM.
- Get Roles - Retrieve the details about roles in your organization.
- Create Role - Add a new role to your organization.
- Update Role - Update the details of a role in your organization.
- Transfer Users and Delete Role - Delete a role and transfer the users to a new role in your organization.
Profiles
In Zoho CRM, the administrator assigns a profile to every user which decides the user's level of access to Zoho CRM data. Use these APIs to perform CRUD operations on the profiles in your organization.
- Get Profiles - Retrieve the data of profiles of your organization.
- Create Profile - Create a profile by cloning an existing profile and making changes to it.
- Update Profile Permissions - Update the permissions of a profile.
- Transfer Users and Delete a Profile - Transfer the users to a new profile and delete the old one.
Territories
Territory management helps you segregate your Zoho CRM records based on customer attributes such as geography, company size, or industry. It also allows you to automatically associate Accounts, Contacts, and Deals with territories to maximize revenue. Use these APIs to perform CRUD operations and more on the territories in your organization.
- Get Territories - Get the list of territories enabled for your organization.
- Add Territories - Add new territories to your organization.
- Update Territories - Update the details of existing territories in your organization.
- Delete Territories - Delete territories from your organization.
- Transfer and Delete Territories - Delete territories with child territories, and transfer the child territories to another parent territory.
- Get Child Territories - Retrieve the details of child territories of your territory.
- Get Territories of a Record - Get the details of the territories assigned to a record.
- Associated User Count of Territories - Retrieve the count of users under the territories in your organization.
- Retrieve User details Associated with a Territory - Retrieve the details of the user added to the territory in your organization.
- Associate Users with Territory - Associate users with a territory in your organization.
- Remove Territories of Records - Remove territories assigned to multiple records or a single record.
- Assign Territories to Records - Assign territories to multiple records or a single record.
- Disassociate Users from Territory - Disassociate users from a territory in your organization.
Export Audit Log
The audit log provides a chronological sequence of actions performed by users in Zoho CRM. Use these APIs to schedule an export, get the details of the job, and download the result.
- Create Export Audit Log - Export the audit log data from your Zoho CRM.
- Get the Status of the Export Audit Log Job - Retrieve the details of the export audit log job.
- Download Export Audit Log Result - Download the results of an export audit log job.
Portals
Portals in CRM allow the administrators to extend CRM access to their contacts, vendors or partners. A portal user can access the modules and some of the associated data that they have been given access to, such as products, invoices, and notes present in CRM. They can also view, edit, an create records, add notes and attachments. Use these APIs to perform CRUD operations and more on Portals and user types.
- Create Portal - Create a portal for your org.
- Update Portal - Update a portal's name in your org.
- Get Portals - Get the details of the portals available in your org.
- Create User Type - Create a user type in a portal.
- Get Portal User Types - Get the user types available in a portal of your org.
- Update User Type - Update the details of a user type in a portal.
- Delete a User Type - Delete a user type from a portal.
- Invite a User to a Portal - Invite a user to a portal.
- Bulk Invite a User to a Portal - Invite users to a portal in bulk.
- Bulk Invite Job Status - Get the status of the job to invite users in bulk to a portal.
- Transfer Users of a User Type - Transfer the users of a user type to another user type in a portal.
- Get Users of a User Type - Get the list of users available in a user type of a portal.
- Change User Status (Portal) - Change the status of a user in the portal.
- Delete User From Portal - Delete a user from a portal.
Data Sharing
Data Sharing in Zoho CRM gives you an option to extend the access rights to CRM records for users belonging to other roles and groups. By default, the Organization Permissions is set as private allowing only the record owner and their manager can view and access the CRM data. Perform CRUD operations and more on Data Sharing Rules using these APIs.
- Get Data Sharing Rules - Retrieve the list of data sharing rules configured in your Zoho CRM organization.
- Create Data Sharing Rule - Create a data-sharing rule that extends access rights to CRM records for users in other roles and groups, or for all users in your Zoho CRM organization.
- Update Data Sharing Rule - Update a data sharing rule configured in your Zoho CRM organization.
- Delete Data Sharing Rule - Delete a data sharing rule from your Zoho CRM organization.
- Get Default Data Sharing Settings - Get your organization's default data-sharing permissions for modules.
- Update Default Organization Permissions - Update your organization's default data-sharing permissions for modules.
Company settings
Business Hours
Business hours define the working hours of an organization, and is typically based on the company's location. Perform CRUD operations on the business hours set for your organization.
- Get Business Hours - Get the details of the business hours of your org.
- Add Business Hours - Set the business hours for your organization.
- Update Business Hours - Update the details of the business hours of your org.
Shift Hours
Shift hours allow you to assign shifts based on employees' work hours or time zone and enable you to assign activities based on a user's availability. Perform CRUD operations on the shift hours set for your organization.
- Get Shift Hours - Get the details of the shift hours configured for your organization.
- Add Shift Hours - Set shift hours for your organization through an API.
- Update Shift Hours - Update the shift hours for your organization through an API.
- Delete Shift Hours - Delete the shift hours configured for your organization.
Fiscal Year
In Zoho CRM, the fiscal year setting helps organizations to configure their fiscal cycle based on the selected start month or end month. Perform API operations on the fiscal year set for your organization.
- Get Fiscal Year - Retrieve the details of fiscal year settings of your organization.
- Update Fiscal Year Settings - Update the details of fiscal year settings of your organization.
Holidays
Every business has its own holidays including the national holidays and the ones specific to the business or the region. Perform cRUD operations on the holidays for your org using these APIs.
- Get Holidays List - Get the details of the holidays set for your org.
- Get the Status of the Export Audit Log Job - Retrieve the details of the export audit log job.
- Add Holiday - Add holidays to your org.
- Update Holidays - Update the holidays set for your org.
- Delete Holiday - Delete the holidays set for your org.
User Groups
You can create different types of groups(set of users) to manage a set of common records. Every group can consist of members that are grouped based on the users, roles, roles and subordinates, territories and sub-territories. These combinations allow you to share common records through data sharing rules. Use these APIs to perform CRUD operations and more on user types of your org.
- Create User Group - Create a user group.
- Update User Group - Update a user group.
- Get User Groups - Get the details of the user groups created for your organization.
- Get Sources by Type - Get the details of a member of a user group by the type.
- Get Sources Count - Get the number of users, groups, roles, and territories available in a user group.
- Delete a User Group - Delete a user group.
- Get Associated Groups of a User - Get the groups that a user is associated with.
- Get Associated Users' Count - Get the number of users associated with each user group.
- User Groups Associations - You can associate a user group with sharing rules, workflows, assignment rules, approval and review processes, and email notification criteria. Use this API to find out where a user group is associated.
Users' Unavailability
Get the details of a user's unavailability, mark yourself unavailable, update and details of your unavailability using these APIs.
- Get User Unavailability - Get the details of a user's unavailability.
- Mark a User Unavailable - Mark oneself(user) unavailable during a particular time period.
- Update User Unavailability - Update the details of your unavailability during a particular time period.
- Delete User Unavailability - Delete the record that contains the details of your unavailability.
Currencies
Perform CRUD operations on the currencies of your org and enable multi-currencies using these APIs.
- Get Currencies Data - Get all the available currencies in your organization.
- Add Currencies - Add new currencies to your organization.
- Update Currencies - Update currency details.
- Enable Multi-Currency - Enable multiple currencies for your organization.
Variables
A CRM Variable can have unique set of values and can be widely used as merge fields in Email templates, Mail merge templates, and Inventory templates. You can also use them as reusable authentication parameters in APIs.
- Get Variables - Retrieve all the available variables through an API request.
- Update Variables - Update the details of variables in CRM.
- Create Variables - Create a new variable in CRM.
- Delete Variable - Delete details of CRM variables.
- Get Variable Group - Get the details of any variable group.
Zia
Zia, Zoho CRM's AI-powered assistant, can help you ensure that your CRM data is complete and updated. Based on information as little as website, name of a company etc., Zia crawls web pages and retrieves additional information such as the company's address, phone, number of employees, the social media handles of the CEO and other public information. This is called Data Enrichment. Refer to this article for more details. When you enable Data Enrichment, you can map the data available over the Internet with the fields in Zoho CRM. Data mapping happens by default for system-defined fields, but you can also map with custom fields. This mapping is called configuration.
Organization Enrichment
- Data Enrichment - Org Level - Initialize or trigger data enrichment on the org level.
- Get Data Enrichment Configuration - Get the details of configuration for data enrichment.
- Get Data Enrichment Configuration - Get the details of the enriched data of your org.
People Enrichment
- Trigger People Enrichment - Initialize or trigger data enrichment at the people(personal) level.
- Get People Enrichment Details - Get the details of the enriched data of your org.
Core APIs
CRUD operations on records, Mass Actions, Subforms, Linking modules, etc,.
Records
Perform CRUD operations on records.
- Get Records - Fetch up to 200 records per API call from a module.
- Insert Records - Insert up to 100 records per API call in a module.
- Update Records - Update up to 100 existing records in the module.
- Delete Records - Delete up to 100 records from a module.
- Insert or Update Records (Upsert Records) - Insert or update a record. The system checks for duplicate records based on the duplicate check field's values. Existing records get updated, while the new ones are inserted.
- Search Records - Retrieve the records that match your search criteria.
- Record Clone - Clone a record in a module.
- Get Rich Text Fields - Get the rich text fields.
- Timeline of a Record - Get the timeline of a record such as the history of all the updates that were made to any of its fields and related records.
- Get Deleted Records - Get the list of deleted records.
- Module Record Count - Fetch the total number of records in the module or the number of records that match the criteria.
- Record Locking - Record Locking Information APIs allow you to lock and unlock records, view locking information and edit locking information of locked records.
- GET Record Locking Information - Retrieve the locking information details of locked records.
- Lock Records - Lock a record of a module.
- Update Record Locking Information - Modify locking information of locked records in different modules.
- Unlock Records - Remove lock from locked records.
- Contact Roles - When multiple contacts are associated with a deal/opportunity, the contacts' details are stored in the Contact Roles related list.
- Get Contact Roles - Get the list of contact roles.
- Insert Contact Roles - Add new contact roles.
- Update Contact Roles - Update details of contact roles.
- Delete Contact Roles - Delete contact roles.
- Get Contact Roles of a Specific Deal - Get the details of contact roles associated with a specific deal.
- Add Contact Roles to a Specific Deal - Add contact roles to a specific deal.
- Remove Contact Role from a Specific Deal - Remove contact roles from a specific deal.
- Attachments - The files and attachments API allows you to get a list of attachments, and to upload or download a photo or a file.
- Get Attachments - Get the list of attachments.
- Upload Attachment - attach a file to a record.
- Download an Attachment - Download a file attached to a record.
- Delete Attachments - To delete a file attached to a record.
- Photos
- Upload Image - Attach a photo to a record.
- Download Record Image - Download a photo associated with a module.
- Delete Record Photo - Delete a photo from a record in a module.
- Change Owner
- Change Owner - Change the owner of a record or multiple records.
- Convert Lead - Get the lead conversion options to identify existing records, if any, before converting a lead to a deal, account, and a contact.
- Get Lead Conversion Options - Fetch the matching records from Accounts, Contacts, and Deals to map the data correctly and avoid any duplicity while converting a lead.
- Convert Lead - Convert a lead into an account, contact, or a deal.
- Convert Inventory Records - Convert Quotes to Sales Orders or Invoices, and Sales Orders to Invoices.
- Convert Inventory Records - Convert inventory records.
Merge Records
Merge up to three duplicate records into a single one, deleting the duplicates.
- Merge Records - Merge up to three duplicate records into a single record and delete the duplicates.
- Get Records Merge Status - Get the status of the previously scheduled records merge job.
Share Records
Share records with other users in the organization through these APIs.
- Get Shared Record Details - Get the details of a shared record.
- Share Record - Share a record with other users, groups, and roles in the organization.
- Update Share Permissions - Update the sharing permissions of a record granted to users, revoke access given to users, update the access permission to the related lists of the record that was shared with the user and share the record privately or publicly.
- Revoke Shared Record - Revoke access to a shared record that was shared to users.
- Record-Level Sharing of Emails - Share emails at record-level for a specific record or multiple records with other users in your Zoho CRM organization.
- Record-Level Unsharing of Emails - Unshare emails at record-level for a specific record or multiple records with other users in your Zoho CRM organization.
Mail Merge
Use mail merge templates to send personalized emails, letters etc to other users without manually typing the information for every user.
- Send Mail using Merge Template - Use a mail merge template and send emails to users
- Sign Mail Merge - Send a mail merge document for signing and approval.
- Download Mail Merge - Use the download mail merge API to download the merged document created using your mail merge template.
Services
Create new services, retrieve or search service records, update service details, delete existing services, and configure service preferences based on various business needs using these APIs.
- Get Services - Get services data that match your search criteria.
- Create Services - Add new services to your organization.
- Update Services - Update the details of an existing service in your organization.
- Delete Services - Delete existing services in your organization.
- Get Service Preferences - Get the details of service preferences in your organization.
- Update Service Preferences - Update the service preferences in your organization.
Appointments
Use these APIs to get, create, update, delete appointments, and set appointment preferences depending on various business needs.
- Get Appointments - Get appointments data that match your search criteria.
- Create Appointments - Add new appointments to your organization.
- Update Appointments - Update the details of an existing appointment in your organization.
- Delete Appointments - Delete existing appointments in your organization.
- Get Appointment Preferences - Get the details of appointment preferences in your organization.
- Update Appointment Preferences - Update the appointment preferences in your organization.
Appointment Rescheduled History
Fetch, create, update and delete the records in the rescheduled history using Appointment Rescheduled History APIs.
- Get Appointments Rescheduled History - Get appointments rescheduled history data.
- Add Appointments Rescheduled History - Add new records in the appointments rescheduled history.
- Update Appointments Rescheduled History - Update the rescheduled details of appointments.
- Delete Appointments Rescheduled History - Delete a record from the appointments rescheduled history.
Fields' Attachments
- Download Field Attachments - Download the attachments from the file upload and image upload fields of a module.
Meeting Cancel
- Meeting Cancel - Cancel a meeting and send an email regarding the meeting cancellation to the participants.
Notes
Perform CRUD operations on the notes of a module.
- Create Notes - Add new notes.
- Get Notes - Get the list of notes in a module.
- Update Notes - Update an existing note.
- Delete Notes - Delete notes.
Mass Actions
Perform mass actions on the records of a module like changing owner, mass update and delete, mass convert lead, etc,.
- Mass Update - Update a specific field of up to 50,000 records by their record IDs or up to 500 records in a custom view/territory.
- Mass Update Records - Bulk-update the values of specific fields for multiple records in territories or custom views in a module.
- Mass Update Status - Get the status of the mass update job scheduled previously.
- Mass Delete - Delete up to 50,000 records in a custom view or delete up to 500 records using their record IDs.
- Mass Delete Records - Delete the records of a module in bulk.
- Mass Delete Status - Get the status of the mass delete job scheduled previously.
- Mass Change Owner - Change the owner of up to 50,000 records in a custom view in an API call.
- Mass Change Owner - Bulk-update the ownership of records in a specific custom view or territory in a module in Zoho CRM.
- Mass Change Owner Status - Retrieve the status of a previously scheduled mass change owner job in Zoho CRM.
- Mass Convert Leads - Convert a maximum of up to 50 leads in a single API call, with or without creating a deal.
- Mass Convert Lead - Convert a maximum of up to 50 leads in a single API call.
- Lead Mass Convert Status - Get the status of the mass convert lead job scheduled previously.
- Mass Convert Inventory Records - Convert a maximum of up to 50 inventory records in a single API call.
- Mass Convert Inventory Records - Mass-convert inventory records. You can convert a record from Quotes to Sales Orders or Invoices, or from Sales Orders to Invoices.
- Mass Inventory Conversion Status API - Get the status of a mass conversion job scheduled for inventory records.
- Mass Update - Update a specific field of up to 50,000 records by their record IDs or up to 500 records in a custom view/territory.
Related Records
Perform CRUD operations on the related records of a module such as attachments, products, deals, contacts, etc,.
- Get Related Records - Get the related list records of a record.
- Get Related Records Count of a Record - Get the count of related records of a record in a module.
- Update Related Records - Update the relation between the records.
- Delink Related Records - Delete the association between modules.
- Get Related Records of a Deleted Record - Get the related list records of a deleted record.
External ID
While you integrate a third-party application, you may want to store the third-party reference IDs in Zoho CRM's records. External ID fields facilitate this requirement of storing an external value inside Zoho CRM.
- Records APIs Using External ID - Perform CRUD operation the records of a module using their external IDs.
- Get Records Using External ID - Fetch the records in a module using external IDs.
- Insert Records using External ID - Add new entities to a module using external ID.
- Update Records Using External ID - Update existing records in a module through an external field.
- Delete Records Using External ID - Delete the records in a module using external IDs.
- Upsert Records using External ID - Update existing records or insert new records in a module through an external field.
- Search Records Using External ID - Retrieve the records that match your search criteria using external fields.
- Related Records APIs using External ID - Perform CRUD operation the related records of a module using their external IDs..
- Get Related Records using External ID - Get the related list records using external IDs.
- Update Related Records using External ID - Update the related list records using external IDs.
- Delete Related Records Using External ID - To delete the related list records using external IDs.
- Records APIs Using External ID - Perform CRUD operation the records of a module using their external IDs.
Emails
- Associate Email with a Record - Associate an email with a record entity.
- Download Email Attachments - Download the attachments of an email.
- Download Inline Images of an Email - Download the inline images from an email.
- Get Email Shared Details - Get the details of the users and the type with whom you can share the record's emails.
- Get Emails of a Record - Get the details of the emails sent from a record.
- Get From Addresses List - Get the list of email addresses that you can send emails from.
- Send Mail - Send emails to the email IDs of other records in Zoho CRM.
- Unblock Email Address - Unblock the soft-bounced emails.
Email Drafts
Email drafts are stored in Email related list of the corresponding record. Use these APIs to perform CRUD operations on the email drafts.
- Create Email Drafts - Create email drafts.
- Get Email Drafts - Get email drafts.
- Update Email Draft - Update an email draft.
- Delete Email Draft - Delete an email draft.
Subforms
Use these APIs to deal with subform data.
- Get Subforms - Get the subform data of a record.
- Insert Subforms - Insert a new record with subforms in a module.
- Update Subforms - Update a record with subforms in a module.
- Update Related Records - Update the relation between the records.
- Delink Related Records - Delete the association between modules.
- Get Related Records of a Deleted Record - Get the related list records of a deleted record.
Others
Other APIs to perform operations on users, organization, recycle bin, etc,.
- Organization - Perform operations on your organization data such as getting the details, upload, download, and delete your organization's photo.
- Get Organization Details - Get the organization data.
- Upload Organization Photo - Upload the photo of your organization.
- Get Organization Image - Get the photo or logo of your organization.
- Delete Organization Image - Delete the logo or photo of your organization.
- Users - Perform CRUD, territory-based operations, and transfer user operations.
- Get Users - Retrieve the users' data specified in the API request. You can specify the type of users that need to be retrieved.
- Add User - Add a user to your organization.
- Update User - Update the details of a user in your organization.
- Delete User - Delete a user from your organization.
- Get Users Count - Fetch the user count in your org. You can get the total number of users, or get the count by user type.
- Get User Territories - Get the territories related to a user.
- Add or Update Territories of a User - Add or update the territories related to a user.
- Remove Territories from a User - Remove specific territories from a user.
- Transfer Records and Delete User - Delete user(s) from CRM and transfer the records to a new user.
- Status of Transfer Records and Delete Users - Get the status of the "transfer records and delete user" job scheduled previously.
- Features - Fetch information about the features in your org and its limits. These limits vary depending on your org's edition.
- Features - Retrieve details of features and its limits for your current org.
- Get User Licences Count - Retrieve the count of purchased, active and available user licences in your organization.
- List of Available APIs - Retrieve the list of supported APIs in the current API version, with the option to filter the APIs based on their request methods, OAuth scopes and credit limits.
- Recycle Bin
- Get Recycle Bin Records - Fetch the records in the Recycle Bin in your CRM account.
- Delete Recycle Bin Records - Delete one or more records from the Recycle Bin in your CRM account.
- Files - Use these APIs to upload files and get the files stored on Zoho's File system(ZFS).
- Get Files - Fetch a file using its encrypted ID.
- Upload Files to ZFS - Upload files to Zoho File System.
- Organization - Perform operations on your organization data such as getting the details, upload, download, and delete your organization's photo.
Bulk APIs
Perform operations on large volumes of data using Bulk Read, Bulk Write, and Data Backup APIs.
Bulk Read
Export up to 200,000 records(as CSV file) per API call from a module, or up to 25,000 records(as ICS) from the Events module using this asynchronous API.
- Create Bulk Read job (Bulk Export) - Create a bulk read job to export records.
- Get the Status of a Bulk Read Job - Get the details of a bulk read job scheduled previously.
- Download Bulk Read Result - Download the bulk read job in zip format.
Bulk Write
Import(Insert, update, or upsert) a maximum of 25,000 records in a single API call using this asynchronous API.
- Bulk Write Upload File - Upload a CSV file in ZIP format for bulk write API.
- Create Bulk Write Job - schedule a bulk write job to import records into CRM.
- Get Bulk Write Job Details - Get the details of a bulk write job scheduled previously.
- Download Bulk Write Result - Download the result of the bulk write job as a CSV file.
Data Backup
Administrators can take a backup of their CRM data, including attachments, through this APIs.
- Schedule Data Backup - Schedule a backup of all CRM data including attachments.
- Get Backup Info - Fetch information about the latest data backup scheduled for your CRM account.
- Get Data Backup History - Fetch information about the recent data backups scheduled for your CRM account in the last one year.
- Download Backed up Data - Download the backed up data for your CRM account.
- Get Backup URLs - Fetch the download URLs of the latest scheduled backup.
- Cancel Scheduled Data Backup - Cancel the scheduled data backup of your CRM account.
Composite API
Combine up to five API requests in a single API and reduce the round-trip-time, save up on credits, and roll back in case of failure, using this API.
- Composite API - To perform a composite API call, consisting of up to five sub-requests.
Query API
Fetch records that match your criteria using CRM's Object Query Language(COQL) that uses SQL-like syntax.
- Get Records through COQL Query - Get records from a module through a COQL query.
- Joins in COQL - You can establish a join or a relation with the help of lookup fields that relate one module with the other using the .(dot) operator.
- Sub-query in COQL - Get records from a module using nested/sub-queries in a COQL query.
Notification APIs
Get notified on record action such as insert, update, or delete in near-real time using the Notification APIs.
- Get Notifications Details - Get the details of the notifications enabled by the user.
- Notifications Enable - Enable instant notifications of actions performed on a module.
- Update Specific Information of a Notification - Update only specific details of a specific notification enabled by the user.
- Update Details of a Notification - To update the details of the notifications enabled by a user.
- Notifications Disable - Stop all the instant notifications enabled by the user for a channel.
- Disable Specific Notifications - Disable notifications for the specified events in a channel.