Kaizen #154 - Dynamically Update Picklist Values in Zoho CRM Workflows

Hello all!

Welcome back to another interesting Kaizen post.

Today, we will discuss how to add automatically or remove values from a picklist field using Deluge within a workflow. This post serves as a solution for the forum post.

Use case

The sales team migrates users from Pipedrive to Zoho CRM. In Pipedrive, the team managed deals using a Kanban view displayed based on the Closing Months (a picklist field). They automated the updating of picklist values to include current and upcoming months based on the deals' closing timelines. 

In Zoho CRM, to replicate this process, users should manually update the picklist values. The requirement is to automate updating the picklist options during record creation or editing within a workflow.

Solution

By triggering the PATCH Fields API (introduced in V6) through a Deluge function within a workflow, this process can be easily automated. Automating picklist updates saves time, reduces the chances of human error, and ensures that picklist values are always up-to-date.

• First, create a custom picklist field called "Closing Month" in the Deals module.
• Then, use the custom picklist along with the Closing Date (a mandatory field date field in the Deals module) within a Deluge function in the Workflow. 
• The PATCH Fields API can be used within the Deluge function to automate updating picklist values and to list the current and upcoming closing dates in deals.

Let us see the steps in detail on how to achieve this case.

Example

Consider the Closing Month as a custom picklist in the Deals module with three months: January, February, and March. Whenever a new deal is created and its closing month matches one of the picklist values, the record will be updated with the corresponding month in the Closing Month field and placed under the existing picklist value in the Kanban view. If the new closing month is not already in the picklist values, then the Deluge function will automatically create a new picklist value, and the record will fall under the new picklist value section in the Kanban view. 

Follow the steps below to achieve our case in Zoho CRM:

1. Create a Custom Picklist Field in the Deals module.
2. Set Up a Workflow.
3. Add a Deluge Function within a workflow.
4. Configure the Workflow.
   

1. Create a Custom Picklist Field in the Deals Module

• Go to Setup > Customization > Modules and Fields.
• Select the Deals module and the desired layout where you want to add the picklist.
• Click on New Fields and then Add New Field.
• Select Picklist as the field type, name it "Closing Month", and add a list of months (In this post, only three months have been added for example purposes).
  

                                  

• Click Done to save the new picklist field.

2. Set Up a Workflow

• Navigate to Setup > Automation > Workflow Rules.
• Click on Create Rule, select the Deals module, and name the workflow in the Rule Name.
• Set the rule to trigger on record creation or update.

                               

The workflow triggers based on the value of the Closing Date in the Deals module, executing the function when the Closing Date is not empty.

3. Add a Deluge Function within a workflow

You can either create a custom function or you can associate an existing one. Below is the Deluge code used within the workflow. 

1. //To map months with Numbers
2. month = {1:"Jan",2:"Feb",3:"Mar",4:"Apr",5:"May",6:"June",7:"Jul",8:"Aug",9:"Sep",10:"Oct",11:"Nov",12:"Dec"};
3. //To retrieve the Deal record
4. dealRecord = zoho.crm.getRecordById("Deals",dealRecordID);
5. info dealRecord;
6. //To retrieve the Closing Date
7. closingDate = dealRecord.get("Closing_Date");
8. info closingDate; 
9. //To get the predefined value from the closing month
10. closingMonth = month.get(closingDate.month());
11. closingYear = closingDate.year();
12. //To Format the Month and Year from the Closing Date
13. picklistValue = closingMonth + " " + closingYear;
14. info picklistValue;
15. //Retrieving Current Picklist Values
16. Dealsfield = invokeurl
17. [
18. url :"https://www.zohoapis.com/crm/v7/settings/fields/5725767000003664513?module=deals"
19. type :GET
20. connection:"zohocrm"
21. ];
22. info Dealsfield;
23. picklistValues = Dealsfield.get("fields").get(0).get("pick_list_values");
24. info picklistValues;
25. //Checking if the Picklist Value Already Exists
26. flag = false;
27. for each  option in picklistValues
28. {
29. if(option.get("display_value").equals(picklistValue))
30. {
31.   flag = true;
32.   info flag;
33. }
34. }
35. //Adding a New Picklist Value if It Doesn't Exist
36. if(flag == false)
37. {
38. requestBody = Map();
39. requestList = List();
40. requestData = Map();
41. picklist = list();
42. picklistobj = Map();
43. picklistobj.put("display_value",picklistValue);
44. picklist.add(picklistobj);
45. requestData.put("pick_list_values",picklist);
46. requestList.add(requestData);
47. requestBody.put("fields",requestList);
48. info requestBody + "";
49. updateField = invokeurl
50. [
51.   url :"https://www.zohoapis.com/crm/v7/settings/fields/5725767000003664513?module=deals"
52.   type :PATCH
53.   parameters:requestBody + ""
54.   connection:"zohocrm"
55. ];
56. info updateField;
57. }
58. //To update the Deal Record
59. requestBody = Map();
60. requestList = List();
61. requestData = Map();
62. requestData.put("Closing_Month",picklistValue);
63. requestList.add(requestData);
64. requestBody.put("data",requestList);
65. info requestBody + "";
66. dealreecordUpdate = invokeurl
67. [
68. url :"https://www.zohoapis.com/crm/v7/Deals/" + dealRecordID
69. type :PUT
70. parameters:requestBody + ""
71. connection:"zohocrm"
72. ];
73. info dealreecordUpdate;

4. Configure the Workflow

Create a custom function by clicking the New Function or associate an existing one to the workflow. In our case, the deluge program has already been written and configured (associated) to the workflow. 

                            

• Under the workflow actions, select Function and choose the function you created.
• Ensure that the function is set to run when the workflow is triggered.
  

Creating a Deal with a Closing Date of January 2nd (Using an Existing Picklist Value)

                                               

Creating a Deal with a Closing Date of April 1st (Adding a New Picklist Value)

The new picklist value, which was not a value previously, has now been added to the picklist.

You can add values to a picklist field using the PATCH Field API. To remove an option from a picklist, use the Update Custom Layout API. Refer to the Sample input to mark picklist options as unused section in the Layouts API documentation.​

Cheers!!!

Related Links

• Configuring Workflow Rules
• Workflow Scenarios
• Workflow Suggestions by Zia
• FAQs: Workflow Rules
  
• Functions

Additional Links

• Zoho CRM V6 APIs
• Zoho CRM V7 APIs

Previous Kaizen:  #153 Interpreting Zoho CRM GraphQL schema  | Kaizen Collection

• Topic Participants

• Subramanian K

  

• Vigneshwaran K

  

• Garron Helman

• Ishwarya SG

  

• Alan Majhail

• 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

• Archiving Contacts

  How do I archive a list of contacts, or individual contacts?

• Cost of good field

  Is there a way we can have cost of good sold as a field added to the back end of the invoicing procedure and available in reports?

• How to add image to items list in Invoice or Estimate?

  Hello! I have just started using Zoho Invoice to create estimates and, possibly to switch from our current CRM/ERP Vendor to Zoho. I have a small company that is installing CCTV systems and Alarm systems. My question is, can I add images of my "items" to item list in Zoho Invoice and Estimates and their description? I would like to show my clients the image of items in our estimates so they can decide if they like these items. And I tell you, often they choose more expensive products just because

• Issue with the Permission to Zoho Form

  I am getting an error by signing in to zoho form as it is stated that i don't have permission to access this is admin account

• CRM templates

  Hello everyone, In my company we use Zoho campaigns where we set up all newsletters and we use Zoho CRM for transactional emails. I have created some templates in Zoho campaigns but from my understanding i cannot use those in Zoho CRM, right?

• Meet Canvas' Grid component: Your easiest way to build responsive record templates

  Visual design can be exciting—until you're knee-deep in the details. Whether it's aligning text boxes to prevent overlaps, fixing negative space, or simply making sure the right data stands out, just ironing out inconsistencies takes a lot of moving parts.

• Addin Support in Zoho Sheet

  Is there any addin support available in zoho sheet as like google marketplace to enhance productivity by connecting with other apps, providing AI data analysis, streamlining business processes, and more?

• Where to integrate Price Book and Product List Price

  Hello, We sync zoho crm all modules with all data to zoho analytics. In zoho crm, we have "Price Books" and "Products" modules, where each product is assigned to a few price books with different list prices. From zoho crm, I am able to export a dataset

• Pending Sales Order Reports

  Pending sale order report is available for any single customer, Individual report is available after 3-4 clicks but consolidated list is needed to know the status each item. please help me.

• Zoho Mail SMTP IP addresses

  We are using Zoho Mail and needs to whitelist IP for some redirections from your service to another e-mails. You can provide IP address list for Zohomail SMTP servers?

• Migrate Your Notes from OneNote to Zoho Notebook Today

  Greetings Notebook Users, We’re excited to introduce a powerful new feature that lets you migrate your notes from Microsoft OneNote to Zoho Notebook—making your transition faster and more seamless than ever. ✨ What’s New One-click migration: Easily import

• Deluge sendmail in Zoho Desk schedule can't send email from a verified email address

  I am trying to add a scheduled action with ZDesk using a Deluge function that sends a weekly email to specific ticket client contacts I've already verified the email address for use in ZDesk, but sendmail won't allow it in its "from:" clause. I've attached

• Zoho Campaigns - Why do contacts have owners?

  When searching for contacts in Zoho Campaigns I am sometimes caught out when I don't select the filter option "Inactive users". So it appears that I have some contacts missing, until I realise that I need to select that option. Campaigns Support have

• One Contact with Multiple Accounts with Portal enabled

  I have a contact that manages different accounts, so he needs to see the invoices of all the companies he manage in Portal but I found it not possible.. any idea? I tried to set different customers with the same email contact with the portal enabled and

• End Date in Zoho Bookings

  When I give my appointments a 30 minutes time I would expect the software not to even show the End Time.  But it actually makes the user pick an End Time.  Did I just miss a setting?  

• Zoho Commerce

  Hi, I have zoho one and use Zoho Books. I am very interested in Zoho Commerce , especially with how all is integrated but have a question. I do not want my store to show prices for customers that are not log in. Is there a way to hide the prices if not

• email forwarding not working

  Your email forwarding service does not work. I received the confirmation email and completed the confirmation, after that nothing and nothing since no matter what I have tried. Shame as everything else was smooth. I spose it's harder to run one of these web based internet mail services than you guys thought!!! can you fix the email forwarding asap PLEASE!

• Google Ads Conversions Not Being Tracked in Zoho CRM

  We have 3 different conversions created in our Google Ads Account. Only one of the 3 conversion types is tracking in Zoho CRM. Our forms are Elementor Forms that are mapped into Zoho CRM. It apprears to me that all leads are showing up in Zoho CRM, but

• Zoho Desk KB article embedded on another site.

  We embed KB articles from Zoho Desk on another site (our application). When opening the article in a new tab, there is no issue, but if we choose lightbox, we are getting an error "To protect your security, help.ourdomain.com will not allow Firefox to

• Enable Locations for Expense

  Hi, please enable Locations (ex Branches) for Zoho Expense so that there is consistency between this app and Zoho Books. Thanks in advance.

• Currency abbreviations

  Hello, Im stuck, and need help. I need the currency fields for example, opportunity value, or total revenue, to be abbreviated, lets say for 1,000 - 1K, 1,000,000 - 1M, and so on, how should I do this?

• Losing description after merging tickets

  Hello, We merge tickets when they are about the same topic from the same client. It happens sometimes. We recently noticed that after the merger only the description from the master ticket is left in a thread. And the slave-ticket description is erased.

• in the Zoho Creator i have File Upload field get the file on submission of the form Get the File and upload to Zoho Books

  in the Zoho Creator i have File Upload field get the file on submission of the form Get the File and upload to Zoho Books . how I get the file From zoho creator and upload to Zoho Books . using Api response = invokeUrl [ url: "https://www.zohoapis.com/creator/v2.1/data/hh/l130/report/All_Customer_Payments/"+input.ID

• Generate a link for Zoho Sign we can copy and use in a separate email

  Please consider adding functionality that would all a user to copy a reminder link so that we can include it in a personalized email instead of sending a Zoho reminder. Or, allow us to customize the reminder email. Use Case: We have clients we need to

• Syntax for URLs in HTML Snippets

  What are some best practices for inserting a URL in an HTML snippet? I've looked at Zoho Help articles on navigation-based and functional-based URLs, but I'm still unclear on how to incorporate them in an HTML snippet. For example, 1. How do I link to

• Rate Limiting in Zoho Flow (OpenAI API)

  Hi Everyone, We are facing some issues when using Zoho Flow as we have a deluge script running which is making external calls to OpenAI endpoint. Sometimes the response takes more than 30 seconds meaning the script will timeout. We want to implement a

• Placing a condition before converting the LEAD

  Hi,  I need some assistance with Lead conversion. I need to place certain conditions before allowing the user to convert the lead.  For example: up until the certain status's doesn't equal "green" don't allow to convert lead.  I tried creating this using

• it is possible to open a widget via deluge script function

  I have one function that is workflow action I call my fucntion I need to call the internal widget it is possible to open or it have to please tell me the solution

• Creator - Portal Custom Domain

  I will pay $100 in crypto to anyone who can actually get my Creator Custom Domain to function (actually tell me how you got yours to).  Domain verifies, Nothing. I've been fighting it a week, multiple chats to customer service. Clearly I'm doing something wrong.  Some datapoints Domain name itself unimportant, can be a string of numbers.  I need to know what registrars are working for you because GoDaddy does NOT.  Do I need hosting? I've tried both ways and nothing works.  I pushed through Cloudflare

• Transitioning to API Credits in Zoho Desk

  At Zoho Desk, we’re always looking for ways to help keep your business operations running smoothly. This includes empowering teams that rely on APIs for essential integrations, functions and extensions. We’ve reimagined how API usage is measured to give

• steps and options to change Domain DNS/Nameservers settings

  Please share the options or steps to change  Domain DNS/Nameservers settings 

• Unable to explore desk.zoho.com

  Greetings, I have an account with zoho which already has a survey subscription. I would like to explore desk.zoho.com, but when I visit it while logged in (https://desk.zoho.com/agent?action=CreatePortal) I just get a blank page. I have tried different

• Employees in Leave Policy exceptions

  In the Leave Policies we should be able to add specific employees to the exception list So it will be like All Employees except A,B,C in the exception list, currently we can only add departments etc

• Searching customer field

  Hello, When entering a receipt, we select customer information. The customer information is synced with Zoho CRM. However, we can't find the customer information because it searches for words that begin with the entered value. It needs to search for words

• How I set default email addresses for Sales Orders and Invoices

  I have customers that have different departments that handle Sales Orders and Invoices. How can i set a default email for Sales Orders that's different than the default email for Invoices? Is there a way I can automate this using the Contact Persons Departments

• Modular Permission Levels

  We need more modular Permissions per module in Books we have 2 use cases that are creating problems We need per module export permission we have a use case where users should be able to view the sales orders but not export it, but they can export other

• Kaizen #157: Flyouts in Client Script

  Hello everyone! Welcome back to another exciting edition of our Kaizen series, where we explore fresh insights and innovative ideas to help you discover more and expand your knowledge!In this post, we'll walk through how to display Flyouts in Client Script

• How get stock name from other column ?

  How get stock name from other column ? e.g. =STOCK(C12;"price") where C12 is the code of the stock

• Adding a developer for editing the client application with a single user license

  Hi, I want to know that I as a developer I developed one application and handed over to the customer who is using the application on a single user license. Now after6 months customer came back to me and needs some changes in the application. Can a customer

• Download an email template in html code

  Hello everyone, I have created an email template and I want to download it as html. How can i do that? I know you can do it via the campaigns-first create a campaign add the template and download it as html from there. But what if i don't want to create

• Next Page