We're revamping how you name custom fields.

Dealing with APIs and custom fields on a regular basis can prove to be tricky. When you create custom fields using an API in the back end, these fields are replicated in the GUI of your Zoho Desk modules. The labels your developer gives to every custom field are reflected verbatim in your Zoho Desk GUI. In the event that the admin of your portal changes a given field label on the front end, the APIs using the corresponding field label will cease to function. They will work again only when you update the APIs with the exact field labels. This process can be time-consuming and cumbersome. That's why we've revamped the naming system for custom fields within Zoho Desk, using API names.

What are API names and how are they different from field labels?

Moving forward, every time you create a custom field using an API, Zoho Desk will automatically generate an API name for the given field. The API name is guaranteed to be unique, and will serve as identification across your help desk modules. The names will be based on the given field label in the application. For example, if you create a custom field with the label 'Customer Type', the API name generated may be something like 'cf_customer_type'. Please note that API names cannot be modified.

How will this affect my day-to-day activities?

Developers must use the newly generated API names (instead of field labels) to make changes to custom fields in the back end. Take a look at the example below to understand how it works. This is a sample field "JSON," created using the apiName key. By December 31st 2019, the name key will be removed. Developers are advised to replace the name key with the apiName key, as they will have to depend on it to update custom field values henceforth.

{ 
 "displayLabel" : "door number", 
 "isCustomField" : true, 
 "toolTipType" : "placeHolder", 
 "showToHelpCenter" : true, 
 "name" : "door number", 
 "apiName" : "cf_door_number", 
 "isEncryptedField" : true, 
 "id" : "4000000049001", 
 "type" : "Text", 
 "maxLength" : 50, 
 "isMandatory" : false 
 }

Also, when you use apiNames to update an entity, make sure that you use "cf "instead of "customField". Refer to the below example:

{ 
"ticketNumber" : "101",  
"subCategory" : "Sub General",  
"statusType" : "Open",  
"subject" : "Hi. There is a sudden delay in the processing of the orders. Check this with high  
priority",  
      "customFields" : {  
           "secondaryEmail" : null,  
              "ModelName" : "zPhone X"  
             }, 
   "cf" : {  
     "cf_secondary_email" : null,  
     "cf_model_name" : "zPhone X" 
    },  
  "dueDate" : "2016-06-21T16:16:16.000Z",  
  "departmentId" : "1892000000006907",  
  "channel" : "Email",  
  "description" : "Hi. There is a sudden delay in the processing of the orders. Check this with"
highest priority",
  "id" : "1892000000042034",  
  "email" : " carol@zylker.com",  
  "status" : "Open"  
}

With this update, admins and agents can change field names in the GUI whenever they need, without affecting the functioning of APIs. If you are concerned about your APIs and want to know more about the changes you should make, you can read this help document .

Where can you find the API names for custom fields?

To view a list of all API names, you can run a search in the OrganizationFields or the Layouts API. The APIs, when searched for, will provide a list of API names corresponding to the fields in a specified module or layout.

We understand that this is a significant change to how you name custom fields within Zoho Desk. We believe that this update will vastly simplify your experience with APIs and custom fields. If you have any concerns or doubts, we'd be happy to hear from you. You can comment below, or send us an email at support@zohodesk.com .

Cheers,

Team Zoho Desk

Update:

In light of the global pandemic, Zoho Desk is extending support for the name key until February 28, 2021. Beginning March 1, 2021, we will only support newly generated API names instead of field labels. If you are still using name keys, we recommend that you replace them with apiName keys.

Zoho Desk Resources

Desk Community Learning Series
Digest
Functions
Meetups
Kbase
Resources
Glossary
Desk Marketplace
MVP Corner
Word of the Day

Topic Participants
Vaidehee
tlewis
Ash | Zoho Desk
Max
Daniel

Sticky Posts
Live Webinar - Work smarter with Zoho Desk and Zoho Workplace integration
Hello customers! Zoho Desk and Zoho Workplace are coming together for a webinar on 14th May, 2024. Zoho Workplace is a suite of productivity apps for email, chat, docs, calls, and more at one single place. Zoho Desk is closely integrated with a few tools
Apple iOS 17 and iPadOS 17 updates for Zoho Desk users
Hello Zoho Desk users! Apple recently announced the release of iOS 17 and iPad OS 17. These latest OS updates will help you stay productive and efficient, through interactive and seamless user experiences. Zoho Desk has incorporated the updates to help
Zoho Desk Partners with Microsoft's M365 Copilot for seamless customer service experiences
Hello Zoho Desk users, We are happy to announce that Zoho Desk has partnered with Microsoft's M365 to empower customer service teams with enhanced capabilities and seamless experiences for agents. Microsoft announced their partnership during their keynote
Zoho Desk Cheat Sheet For The Year-End
Check out these Zoho Desk best practices to end this year on a high and have a great one ahead! #1 Set Business (Holiday) Hours - If you have limited working hours, please make sure you restrict your business hours or set them as holidays for the coming days. Let your customers know when you will, and won't, be available. #2 Update the Annual Holiday List - Check the holidays for the new year and update the holiday schedule. Usually, holidays from the current year will be carried over for the next
Deprecation of older versions of ASAP Mobile SDK | Zoho Desk
Hello, everyone. Greetings from Zoho Desk ASAP! In order to continue to deliver the best and most secure experience to our mobile SDK users. On account of the recent enhancements and updates to the mobile SDKs, we have planned to mark the older versions