Kaizen #161: Global Sets using Zoho CRM APIs

 Hello all!

In this week, we will see how to work on the Global Sets using our Zoho CRM APIs. Global Picklist APIs were introduced in Zoho CRM API version 6.

In this post, we will cover the following

• Global Sets in Zoho CRM
• Advantages of the Global Sets
• Use case
• Create a Global Set using the POST Global Picklist API
• Use the Global Set with a Picklist Field in the Required Modules
• Update the Global Set Values Using the PATCH Global Picklist Field API
• Conclusion
  

Global Sets in Zoho CRM

Zoho CRM offers an efficient way to maintain a set of data that will be used commonly across the modules to maintain accuracy via the Global Sets or Global Picklists.

Global Sets or Global Picklists are collections of picklist values that can be associated with multiple picklists across modules. When you create Global Sets, you define a set of values that can be associated with fields in different CRM modules, ensuring uniformity in data input across your organization. Refer to this link to know more about Global Sets.

Advantages of Global Sets

• Consistency: The same list of values is available across multiple modules, reducing errors and inconsistencies in data entry.
• Time-saving: You do not have to update picklist values in each module manually. Once updated centrally, changes reflect across all associated fields in all modules.
• Scalability: Easily expand your picklist when your business grows, adding new values (e.g., Adding new showroom location for franchises) without repetitive work.
• Easy Management: Centralized management of picklist values means less administrative work.
  

Use case

Global Picklist for Showroom Locations at Zylker Electronic Franchise 

Zylker, an electronics business franchise, operates several showrooms across multiple cities, all managed in Zoho CRM. As the franchise expands, they need to add new showrooms to various modules such as Leads, Deals, and Services frequently.  Whenever a new showroom opens, they can update the Global Picklist, ensuring that all modules are updated instantly and preventing inconsistencies.

In these situations, different teams manually entering showroom locations in the picklist field can lead to mistakes like typos or different spellings of the same location.

By implementing a Global Picklist for "Showroom Location," Zylker ensures that all teams select from the same list of showroom locations.

Create a Global Set using the POST Global Picklist API

Create a Global Set with the desired values. 

Request URL:  {api-domain}/crm/{version}/settings/global_picklists

Request Method: POST

Request Body: 

{     "global_picklists": [         {             "display_label": "Showroom Location",             "description": "Use this picklist option to manage showroom locations across all modules in your CRM.",             "pick_list_values": [                 {                     "display_value": "New York Showroom",                     "sequence_number": 1,                     "actual_value": "New York Showroom"                 },                 {                     "display_value": "Los Angeles Showroom",                     "sequence_number": 2,                     "actual_value": "Los Angeles Showroom"                 },                 {                     "display_value": "Chicago Showroom",                     "sequence_number": 3,                     "actual_value": "Chicago Showroom"                 },                 {                     "display_value": "Houston Showroom",                     "sequence_number": 4,                     "actual_value": "Houston Showroom"                 }             ]         }     ] }

If the API call is successful, a global picklist will be created with the specified options. The following GIF demonstrates the newly created global picklist in the UI.

Use the Global Set with a Picklist Field in the Required Modules

Create picklist fields in the required modules, such as Leads and Contacts, and link the created Global Set with a picklist field in modules using the Create Custom Field API.

Follow the below steps to link the created Global Set with a picklist field in a module.

Step 1: Retrieve the unique ID of the Global Set 

Retrieve the unique ID of the created Global Set using the GET - Global Picklists API to link it with a picklist field. The below URL retrieves all Global Sets in your org.

Request URL: {api-domain}/crm/{version}/settings/global_picklists

Request Method: GET

Response:

The API retrieves all available Global Sets in the organization.

In this case, the "Showroom Location" field needs to be associated with the modules, and its unique ID is 5725767000004230002. Use the following request URL to view the specific global picklist field along with its options.

Request URL: {api-domain}/crm/{version}/settings/global_picklists/5725767000004230002

Request Method: GET

Response:

Step 2: Use the Global Set in the desired module

Create a new picklist field in the required modules and associate the "Showroom Location" Global Set with the picklist field.

• Leads - To track customer inquiries by showroom location.
• Deals - To monitor sales by showroom location.
• Sales Orders - To process orders based on showroom location.
• Service Requests - To handle customer service tickets by showroom location.
  

This post uses the "Leads" module as an example. Use the Create Custom Field API to associate the Global Set with the Leads module.

Request URL: {api-domain}/crm/{version}/settings/fields?module=Leads

Note: The module parameter is mandatory to create a field in a module.

Request Method: POST

Request Body:

{     "fields": [         //Associating the Showroom Location Global Set with the Leads module         {             "field_label": "Showroom",  //The Showroom field in the Leads module, where the "Showroom Location" Global Set is associated             "data_type": "picklist", //To associate a global picklist, use the data type "picklist"             "global_picklist": {                 "id": "5725767000004230002" //ID of the global picklist             }         }     ] }

Response in the UI:

Use the above process to create the Global Set across modules using the Create Custom Field API. 

Below are the request URLs to associate the field with other modules as per our use case:

{api-domain}/crm/{version}/settings/fields?module=Deals {api-domain}/crm/{version}/settings/fields?module=Sales_Orders {api-domain}/crm/{version}/settings/fields?module=Service_Requests

Update the Global Set Values Using the PATCH Global Picklist Field API

Any changes made to the Global Set will automatically reflect across all modules associated with it. Use the PATCH - Global Picklist Field API to update the values in a Global Set.

Request URL: 

{api-domain}/crm/{version}/settings/global_picklists/5725767000004230002

Request Method: PATCH

Request Body:

{     "global_picklists": [         {                          "pick_list_values": [                 {                     //"display_value": "New York Showroom",                      "id": "5725767000004230003",                      "type": "unused" // to move the option to the unused state                 },                 {                     "display_value": "Chicago Showroom",                     "sequence_number": 3,                     "actual_value": "Chicago Showroom",                     "id": "5725767000004230007",                     "type": "unused",                     "_delete": null // deleting the option from the global Field                 },                 // Creating a new option or adding a new showroom location to the Global Set                  {                     "display_value": "San Francisco Showroom",                     "actual_value": "San Francisco Showroom"                 },                 {                     "display_value": "Boston Showroom",                     "actual_value": "Boston Showroom"                 }             ]         }     ] }

Using the PATCH Global Picklist API, you can easily manage and perform various operations. In the above request, Zylker performed the following operations:

• Moving an Option to Unused State: The "New York Showroom" option is marked with "type": "unused", meaning the showroom is moved to the "unused" state, indicating the option is no longer active but has not been deleted from the system.
  
• Deleting an Option: The "Chicago Showroom" option is deleted from the picklist field using the  "_delete": null, meaning the option is removed or deleted from the system and is no longer valid.
  
• Adding New Options: In addition to the above operations, two new showrooms namely "San Francisco Showroom" and "Boston Showroom", are added to the field using the "display_value"(mandatory) and "actual_value" (optional), as Zylker expands its franchise to new cities and manages them across the modules.

Note: The updated value will replace its old value in areas such as Records, Criteria, Workflow Actions, and Field Dependency. 

Conclusion

Hence, the Global Sets help Zylker keep the showroom location list up-to-date and consistent across modules, making it easier to manage showroom locations in their CRM system.

We trust that this post meets your needs and is helpful. Let us know your thoughts in the comment section or reach out to us at support@zohocrm.com

Stay tuned for more insights in our upcoming Kaizen posts!

Cheers!!!

Previous Kaizen Post: Kaizen #160 -  Automating ZDK CLI commands using shell scripting | Kaizen Directory | Kaizen Collection

• Topic Participants

• Subramanian K

  

• Vitor

  

• Jeganprabhu S

  

• Anamika Prasanth

  

• Sticky Posts

• Kaizen #197: Frequently Asked Questions on GraphQL APIs

  🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.

• Kaizen #198: Using Client Script for Custom Validation in Blueprint

  Nearing 200th Kaizen Post – 1 More to the Big Two-Oh-Oh! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.

• Celebrating 200 posts of Kaizen! Share your ideas for the milestone post

  Hello Developers, We launched the Kaizen series in 2019 to share helpful content to support your Zoho CRM development journey. Staying true to its spirit—Kaizen Series: Continuous Improvement for Developer Experience—we've shared everything from FAQs

• Kaizen #193: Creating different fields in Zoho CRM through API

  🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.

• Client Script | Update - Introducing Commands in Client Script!

  Have you ever wished you could trigger Client Script from contexts other than just the supported pages and events? Have you ever wanted to leverage the advantage of Client Script at your finger tip? Discover the power of Client Script - Commands! Commands

• Recent Topics

• Search in module lists has detiorated

  Every module has a problem with the search function :-/

• YouTube Live #1: AI-powered agreement management with Zia and Zoho Sign

  Hi there! We're excited to announce Zoho Sign’s first YouTube live series, where you can catch the latest updates and interact with our Zoho Sign experts, pose questions, and discover lesser-known features. We're starting off by riding the AI wave in

• Search in module lists has detiorated

  Every module has a problem with the search function :-/

• Sales Receipts Duplicating when I run reports why and how do we rectify this and any other report if this happens

  find attached extract of my report

• Add Zoho Forms to Zoho CRM Plus bundle

  Great Zoho apps like CRM and Desk have very limited form builders when it comes to form and field rules, design, integration and deployment options. Many of my clients who use Zoho CRM Plus often hit limitations with the built in forms in CRM or Desk and are then disappointed to hear that they have to additionally pay for Zoho Forms to get all these great forms functionalities. Please consider adding Zoho Forms in the Zoho CRM Plus bundle. Best regards, Mladen Svraka Zoho Certified Consultant and

• Bigin: filter Contacts by Company fields

  Hello, I was wondering if there's a way to filter the contacts based on a field belonging to their company. I.e.: - filter contacts by Company Annual Revenue field - filter contacts by Company Employee No. field In case this is not possibile, what workaround

• Has Zoho changed the way it searches Items?

  Right now all of our searches have broken and we can no longer search using the SKU or alias. It was fine last night and we came in this morning to broken.....this is impacting our operations now.

• Refunds do not export from Shopify, Amazon and Esty to Zoho. And then do not go from Zoho inventory to Quickbooks.

  I have a huge hole in my accounts from refunds and the lack of synchronisation between shopify , Amazon and Etsy to Zoho ( i.e when I process a refund on shopify/ Amazon or Etsy it does not come through to Zoho) and then if I process a manual credit note/

• CRM->INVENTORY, sync products as composite items

  We have a product team working in the CRM, as it’s more convenient than using Books or Inventory—especially with features like Blueprints being available. Once a product reaches a certain stage, it needs to become visible in Inventory. To achieve this,

• Zoho Calendar not working since a few days

  Hey there, first off a minor thing, since I just tried to enable the Calendar after reading this in another topic (there was no setting for this though) : For some reason my current session is showing me based in New York - I'm in Germany, not using a

• Monthly timesheet, consolidation of time by project

  I have time logs for various jobs for project. Is it possible to consolidate the time spent for each job, when I am generating a timesheet for a month? I am getting the entries of jobs done on each day when I generate a timesheet for a month For example

• Building a Strong Online Identity with G-Tech Solutions

  In today’s fast-moving world, having a strong online identity is essential for every business. https://gtechsol.com.au helps businesses establish a digital presence that reflects their vision and values. By focusing on innovation and quality, they create

• Sending emails from an outlook account

  Hi, I need to know if it's possible to send automatic emails from an Outlook account configured in Zoho CRM and, if so, how I can accomplish that. To give you some context, I set up a domain and created a function that generates PDF files to be sent later

• Struggling with stock management in Zoho CRM – is Zoho Inventory the solution?

  My biggest pain point today with Zoho is inventory management. I run a retail business and reliable stock management is absolutely critical. Obviously, I need this inventory to be visible inside the CRM. At first, I tried handling it through custom modules

• Automating CRM backup storage?

  Hi there, We've recently set up automatic backups for our Zoho CRM account. We were hoping that the backup functionality would not require any manual work on our end, but it seems that we are always required to download the backups ourselves, store them,

• Nimble enhancements to WhatsApp for Business integration in Zoho CRM: Enjoy context and clarity in business messaging

  Dear Customers, We hope you're well! WhatsApp for business is a renowned business messaging platform that takes your business closer to your customers; it gives your business the power of personalized outreach. Using the WhatsApp for Business integration

• can't login Kiosk URGENT

  already try, can't login pls help to support. thanks.

• 【Zoho CRM】CRM for Everyoneに関するアップデート：関連データ機能

  ユーザーの皆さま、こんにちは。コミュニティチームの中野です。 今回は「Zoho CRM アップデート情報」の中から、CRM for Everyoneの新機能「関連データ機能」をご紹介します。 関連データ機能は、あるタブのデータを別のタブに柔軟に関連付け、異なるタブで管理されている情報を1か所にまとめて表示できます。 たとえば、組織タブとチームタブのデータを関連付けることで、必要な情報に効率よくアクセスでき、顧客理解を深めながら他チームとの連携もスムーズに行えます。 目次 1. 関連データの設定方法

• Zoho Books

  How do I manually insert opening balance?

• Profit / margins on Sales orders / Invoices / Estimates

  When we select an SKU or item name in any of these documents, much info such as invoice.line_items.rate is pulled from the item & filled into the document being worked on. If we had another lineItem DB field (hidden) auto filled at the same time: invoice.line_items.purchase_rate

• Inventory to Xero Invocie Sync Issues

  Has anyone had an issue with Invoices not syncing to Xero. It seems to be an issue when there is VAT on a shipping cost, but I cannot be 100% as the error is vague: "Unable to export Invoice 'INV-000053' as the account mapped with some items does not

• How to activate RFQ? What if a price list has ladder price for items?

  Where can I find the option to activate request for quotation? How does it work? If the item has ladder price, does it gets calculated depending on how many items are in the cart?

• Mailk got blocked / Inquiry About Email Sending Limits and Upgrade Options

  Dear Zoho Support Team, My name is Kamr Elsayed I created this account to use for applying for vocational training in Germany. As part of this process, I send multiple emails to different companies. However, after sending only 8 emails today, I received

• Can't join canal Developers Zoho User

  Hello, I received an invitation to join this channel, but I get an error when I try to join it, and I get the same error when I go to the Zoho Cliq interface > Search for a channel. Is this because I don't have a license linked to this email address?

• Desk Email reply - set default font / use custom font

  Hello, in our e-mails, which we send to our customers, a certain font must be used (Corporate Design): Segoe UI https://en.wikipedia.org/wiki/Segoe#Segoe_UI How can this be included? How can this be set as the default font to ensure that this font is

• PDF Templates - Checkbox Borders

  Is there a way to remove the border of a radio/checkbox on a PDF? I'd like to use the function of checkbox but if there's no easy way to remove the border (the PDF form already has a rectangle so it gets cluttered), then I'm forced to create a single

• Zoho CRM's custom views are now deployable from sandboxes

  This feature is now available for users in the AU, JP, and CN DCs. This feature is now available for users in CA and SA DCs. New update: This feature is now available for users in all DCs. Hello everyone, We're excited to announce that you can now deploy

• Settings Icon No Longer in ZOHO Desk?

  In ZOHO desk, there has been a gear icon for settings. as of yesterday, it is no longer there. I showed up briefly this morning but is gone again. Anybody else experiecing this?

• Introducing the all-new email parser!

  Greetings, We are pleased to introduce to you, a brand-new, upgraded version of the Zoho CRM Email Parser, which is packed with fresh features and has been completely redesigned to meet latest customers needs and their business requirements. On that note,

• Tip #43 - Track, Review, and Analyze Your Assist Sessions with Reports-'Insider Insights'

  Did you know you can generate detailed reports for both remote support sessions and unattended access sessions in Zoho Assist? This makes it easy to monitor technician activity, measure efficiency, and review customer interactions. Let us now take a closer

• Function #20: Custom calculation in item table of invoices

  When you create an invoice in Zoho Books, the 'Amount' of a line item is typically calculated as the product of the "Quantity" and the "Rate" of the item. For instance, if an item has a sales rate of $50 and a quantity of 5 is sold, then the amount would

• CBSA - GST CHARGES on imports

  Hi there, We have a questions about landed cost categorization. We received a shipment from overseas. CBSA invoiced us for the GST on the items. Now we entered the CBSA-GST as a separate bill and attached it as landed cost to the main invoice based on

• Simplified Call Logging

  Our organization would like to start logging calls in our CRM; however, with 13 fields that can't be removed, our team is finding it extremely cumbersome. For our use case, we only need to record that a call happened theirfor would only need the following

• Sub form doesn't as formula field

  Is it possible to get formula field in sub form in futures?

• Week date range in pivot table

  Hello, I need to create a report that breakouts the data by week.  I am using the pivot table report, and breaking out the date by week, however the date is displayed as 'Week 1 2014' format.  Is there anyway to get the actual dates in there? ex. 1/6/2014-1/12/2014 Thanks,

• How do I get Status History data of my Projects?

  I want to build a table in Zoho Analytics that Groups by Date, when Projects entered a certain status. I cannot find Status History or any such useful data available in the Setup of my Data Source sync. Please advise how I can achieve this?

• Is it possible to hide fields in a Subform?

  Since layout rules cannot be used with Subforms, is there another way, or is it even possible, to hide fields in a subform based on a picklist fields within said subform? For example, if the Service Provided is Internet, then I do not want to see the

• Weekly Tips :Instantly find what you need with Attachment Viewer

  Your inbox must be packed with project emails, shared notes, and scattered attachments. You are looking for one specific file—a presentation slide or maybe a media clip from a team update—but don’t want to dig through endless email threads or switch between

• Putting Watermark on Zoho Sheet

  Can this be done?

• Missing Zoho Desk integration option for form workflows

  According to the help page "Configure Zoho Desk integration in form workflows" we should be able to select Zoho Desk as an integration target but when I open the integrations list then Zoho Desk is not being listed in it. We are on the Premium plan which should already support Zoho Desk integrations.

• Next Page