APIs and References

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.