API Names

API Names

For each module, field and related list label in Zoho CRM, a unique name called api_name will be generated to use in APIs. These API names are generated internally while creating a custom module, field or related list label.

This key "api_name" will be referred in the JSON data while accessing the CRM API to integrate your business applications. For example, if you want to access the Feeds module, "Feeds" is the API name that can be used everytime you access the resource.

View API names

  1. Go to Setup > API, Apps & Integrations > Developer Space > CRM API.
  2. Under the API Names tab, you can view the list of API names for all the available modules.

    Click any module name to view the list of API names for the available module fields.
Note: API Names for the default modules, fields and related lists cannot be altered. You are allowed to change the API names only for custom modules, fields and related lists.

Important Notes

  • The generated API name can contain only alphabets, numbers and underscore.
  • The API name should start with an alphabet and should not have two consecutive underscores or end with an underscore.
  • Only the custom created modules, fields and related list can be modified.

    • Related Articles

    • Using API Key - Serverless Functions

      Introduction A severless function within your CRM can be invoked from any third-party application or within the CRM using a webhook. However, generally most of the webhooks do not support OAuth2, save for a few of them. In that case, you can execute ...

    • API Reference

      PhoneBridge API Documentation curl NAV Introduction Zoho CRM introduces the PhoneBridge API (Application Programming Interface) to integrate your PBX (Private Branch eXchange) system with Zoho CRM. Upon successful integration, the following ...

    • API Deprecation & Transition | Zoho CRM

      ZOHO   CRM Features Pricing Customers Resources Developers Resources CRM Setup Using Zoho CRM Integrations Developer Guide API Deprecation Announcement Deprecation of Zoho CRM API Version 1 API V2.0 Kick-off: February 2018 The latest version of Zoho ...

    • Get Records API Samples | Online Help - Zoho CRM

      Get Records - Examples The examples used in this section use REST API resources to retrieve, insert, update, and delete records, along with other record-related operations. Get Records from page 1 of the Leads module Purpose To get the list of ...

    • API Limits

      The Version 1.0 of Zoho CRM APIs are in the End-of-Life period and will be deprecated on Dec 31, 2018. We recommend you to check out the new and better API 2.0. The Zoho CRM API is available in all editions of Zoho CRM. To use the API, you'll require ...