Kaizen 215 - Workflow APIs - Part 3

Welcome back to another week of Kaizen!

Over the last couple of weeks, we’ve joined Zylker Cloud Services as they review and improve their workflows. In Part 1, we discovered and audited their sprawling workflow landscape. In Part 2, we learned how to use the Configuration API to understand valid triggers and actions, preventing errors before they happen.

Now, it is time to take action. Zylker has identified the "VP Alert - High Value Deal" workflow as a prime candidate for an update. It is old, has never run, and its logic might be too narrow. We will also explore how to create a new workflow from scratch to handle a new business requirement.

 STEP 5: Update an Existing Workflow 

From our audit in Step 2, we know that the existing ‘VP Alert - High Value Deal’ workflow (id: 4876876000016390024) hadn’t triggered even once. The original $50,000 threshold missed many valuable deals. Most winning opportunities actually land above $30,000. It has never executed, suggesting the criteria are too strict.

Let us use the Update Workflow Rule API to fix it. We'll change the criteria to trigger for deals greater than or equal to $30,000 and add an additional email notification.

 What you can and cannot update 

When working with the Update Workflow Rule API, not every field in a workflow is open for modification. Think of it like editing an existing automation blueprint. Some foundations are fixed, while others are flexible.

You can update:

• Name and Description

• Trigger : You can update triggers, but only within the same trigger type. For example, you can change a Record Action trigger from create to edit, but not from a Record Action trigger to a Score-based trigger. For more details on this, please refer to our detailed help documentation here.

• Conditions and Criteria : add, remove, or refine them.

• Actions : add new ones, remove existing ones, or update their configuration.

• Status : activate or deactivate a workflow rule. 

What cannot be updated

There are a few key restrictions to remember:

• You cannot change the module associated with the workflow.

• You cannot switch trigger categories (e.g., from Record Action to Email Trigger).

• You cannot retain unsupported actions when changing to a trigger that doesn’t support them. For instance, if you change a trigger from Edit to Delete, but keep an Assign Owner action, the update will fail, because “Assign Owner” isn’t valid for Delete triggers.

Updating an existing workflow is not about replacing everything. it is about editing precisely what needs to change.

Here is how to do it:

• Fetch the workflow details using the Get Workflow Rule API. This gives the full structure,  including condition IDs, action IDs, and trigger details.

• Identify what needs to change.

In this case, to fix the  “VP Alert - High Value Deal” workflow, we can update the Workflow rule to:

• lower the threshold to $300,000

• change the comparator to greater_than. 

To make the workflow more useful, Zylker has also decided to add a few new actions.

But before doing that, the developers needed to confirm which actions are supported for this workflow’s trigger type. That is where last week’s Configuration API comes in handy. Since we already know this is a Record Action trigger (create_or_edit), we can refer to the configuration response we explored in Part 2 to see which actions are valid. 

{                 "api_name": "create_or_edit",                 "deprecated": false,                 "name": "CreateorEdit",                 "scheduled_actions_supported": true,                 "actions": [                     "field_updates",                     "assign_owner",                     "add_tags",                     "remove_tags",                     "email_notifications",                     "tasks",                     "create_record",                     "create_connected_record",                     "add_meeting",                     "webhooks",                     "functions",                     "circuits",                     "flow"                 ] },

 

The response clearly shows that email notifications, field updates, and tags are all supported for this trigger type. With that confidence, in addition to updating the condition, we can also add a 'Priority' tag to those records that trigger the Workflow. This makes the workflow more visible and actionable across the sales hierarchy.

Sample Request:

PUT {{api-domain}}/crm/v8/settings/automation/workflow_rules/4876876000016390024

{     "workflow_rules": [         {             "description": "Notify sales leadership and track strategic opportunities",             "name": "VP Alert - High Value Deal.",             "conditions": [                 {                     "sequence_number": 1,                     "criteria_details": {                         "criteria": {                             "group_operator": "AND",                             "group": [                                 {                                     "comparator": "greater_than", // change in comparator operator                                     "field": {                                         "api_name": "Amount"                                     },                                     "value": "300000"   // Lowered threshold                                 },                                 {                                     "comparator": "equal",                                     "field": {                                         "api_name": "Stage"                                     },                                     "value": "Negotiation/Review"                                 }                             ]                         }                     },                     "instant_actions": {                         "actions": [                             {                                 "type": "add_tags",                                 "module": "Deals",                                 "details": {                                     "tags": [                                         {                                             "name": "Priority"                                         }                                     ],                                     "overwrite": true                                 }                             }                         ]                     },                     "id": "4876876000016390025" // id of the condition to be updated                 }             ]         }     ] }

 

After this update, the workflow now triggers for any deal worth more than $300,000 in the Negotiation/Review stage. Apart from sending the email notifications and adding the follow up task, it also tags these deals as Priority.

 Edit vs Add: 

To edit an existing condition or action, include its existing id in your update payload. Zoho CRM will recognize it as an update to that object.

To add a new condition or action, simply omit the id. CRM treats any object without an ID as a new addition.

 STEP 6: Create a new Workflow Rule 

With the “VP Alert - High Value Deal” workflow now fixed and performing as expected, Zylker’s sales team quickly began to see results.
But their sales team noticed that deals often stall after proposals are sent, with no systematic follow-up. Zylker has hence refined the requirements for a new Workflow.

They want to automatically trigger follow-up actions when a high-value deal (above ₹30,000) is marked “Closed Lost” due to pricing reasons. This workflow must ensure that every lost opportunity is reviewed, tagged, and re-engaged after a cooling-off period. To achieve this, they want to create a workflow to be triggered whenever a deal’s Stage is updated to Closed Lost. It must perform the following actions:

• Add tags Lost due to Pricing and Re-engagement Pending.

• Send an email alert to the Sales team, with the details of the failed Deal, so they can look into the reasons.

• After 30 business days, automatically create another “Lost Deal - Feedback” task to remind the owner to re-contact the customer for feedback, and for future opportunities. 

Before proceeding, Zylker makes an API call to the Workflow Configuration endpoint. This ensures that their chosen trigger type and actions are supported. From the response snippet below, it is clear that a field_update trigger supports scheduled actions and the required action types.

{                 "api_name": "field_update",                 "deprecated": false,                 "name": "FieldUpdate",                 "scheduled_actions_supported": true,                 "actions": [                     "field_updates",                     "assign_owner",                     "add_tags",                     "remove_tags",                     "email_notifications",                     "tasks",                     "create_record",                     "create_connected_record",                     "add_meeting",                     "webhooks",                     "functions",                     "circuits",                     "flow"                 ] }

 

With these details validated, we can now move on to adding a new workflow for Zylker using the Create Workflow Rule API request.

Understanding the input JSON structure 

Every workflow definition follows the same hierarchy - defining when the rule runs, what conditions it checks, and which actions it performs.

The top-level input object contains a workflow_rules array. You must include just one workflow rule object per request. Each workflow rule defines its name, trigger type, and one or more condition blocks, each with its own criteria and actions.

Here is a breakdown of what is inside a single workflow rule:

{   "workflow_rules": [     {       "name": "VP Alert - High Value Deal.",   //name of the workflow rule       "description": "Notify leadership when high-value deals are lost due to pricing.",       "module": { "api_name": "Deals" },   //module to which the workflow applies       "execute_when": { ... },         //trigger configuration (e.g., on record edit, field update, etc.)       "conditions": [         {           "sequence_number": 1,          // order of execution. this is the first condition           "criteria_details": { ... },           // condition logic (criteria group)           "instant_actions": { "actions": [ ... ] },  //instant actions executed instantly           cheduled_actions": [              // schedules actions executed after a delay             {                       "execute_after": { ... },              // delay period for the scheduled action                         "actions": [ ... ]             }           ]         },         {           "sequence_number": 2,                      // second condition           "criteria_details": { ... },           "instant_actions": { "actions": [ ... ] }         }       ]     }   ] }

Associative vs. Non-Associative Actions 

Every workflow rule performs one or more actions like sending an email, creating a task, or updating a field, etc. These actions fall into two broad categories: associative and non-associative.

Type	Description	Example Actions
Non- Associative Actions	These are defined inside the workflow rule itself. They do not need to exist beforehand. You can configure their details directly within the workflow payload.	Create record, schedule a call, add a meeting, convert records, social actions, create record on email received, assign owner,
Associative Actions	These are reusable actions created separately in CRM and referenced by their IDs. They can be used across multiple workflows and other automation tools.	Field updates, Email notifications, tasks, Webhooks, Add/Remove tags

 

When you create or update a workflow via API, the associative actions require you to pass their existing action IDs. These IDs can be fetched using the corresponding Actions APIs : Field Updates, Email Notifications, Webhooks, and Tasks. In the coming weeks of Kaizen, we will take a closer look at each of these Actions APIs. We will see how to create, manage, and delete them within your workflow automation strategy.

Sample Request:

POST {{api-domain}}/crm/v8/settings/automation/workflow_rules

{     "workflow_rules": [         {             "execute_when": {                 "details": {                     "trigger_module": {                         "api_name": "Deals",                         "id": "4876876000000002181"                     },                     "criteria": {                         "comparator": "equal",                         "field": {                             "api_name": "Stage",                             "id": "4876876000000002565"                         },                         "type": "value",                         "value": "Closed Lost"                     },                     "repeat": false,                     "match_all": false                 },                 "type": "field_update"             },             "module": {                 "api_name": "Deals",                 "id": "4876876000000002181"             },             "description": "Triggers tasks, tags, and follow-up reminders for high-value deals lost due to pricing",             "name": "Lost Deal due to Pricing - Follow Up",             "conditions": [                 {                     "sequence_number": 1,                     "instant_actions": {                         "actions": [                             {                                 "name": "Lost Deal - Feedback",                                 "id": "4876876000016794047",                                 "type": "tasks"                             },                             {                                 "details": {                                     "module": {                                         "api_name": "Deals",                                         "id": "4876876000000002181"                                     },                                     "over_write": false,                                     "tags": [                                         {                                             "name": "Lost due to Pricing",                                             "id": "4876876000016794071",                                             "color_code": "#658BA8"                                         },                                         {                                             "name": "Re-engagement pending",                                             "id": "4876876000016794075",                                             "color_code": "#879BFC"                                         }                                     ]                                 },                                 "type": "add_tags"                             },                             {                                 "name": "Deal Lost Alert",                                 "id": "4876876000016794062",                                 "type": "email_notifications"                             }                         ]                     },                     "scheduled_actions": [                         {                             "execute_after": {                                 "period": "business_days",                                 "unit": 30                             },                             "actions": [                                 {                                     "name": "Lost Deal - Feedback",                                     "id": "4876876000016794047",                                     "type": "tasks"                                 }                             ]                         }                     ],                     "criteria_details": {                         "criteria": {                             "group_operator": "AND",                             "group": [                                 {                                     "comparator": "greater_equal",                                     "field": {                                         "api_name": "Amount",                                         "id": "4876876000000002557"                                     },                                     "type": "value",                                     "value": "30000"                                 },                                 {                                     "comparator": "equal",                                     "field": {                                         "api_name": "Reason_For_Loss__s",                                         "id": "4876876000002440001"                                     },                                     "type": "value",                                     "value": "Price"                                 }                             ]                         }                     }                 }             ]         }     ] }

 

The execute_when defines when the workflow should fire.

• type = field_update means this rule runs when a field’s value changes.

• criteria : Stage = Closed Lost so the rule triggers whenever the Stage field is updated to Closed Lost.

• repeat = false ensures it will not trigger multiple times for the same record. 

In simple terms: “Whenever a deal is marked as Closed Lost, run this workflow.” The criteria_details section refines the trigger. The workflow only runs when the Amount ≥ ₹30,000 AND Reason for Loss = Price.

The instant_actions section inside the conditions array has the actions to be executed immediately when the criteria are met.

• Add Tags : labels the record for easy filtering and reporting.

• Send Email Alert : notifies the sales team instantly about the lost deal.

The scheduled_actions defines what happens after some time has passed. In this case, after 30 business days. Here, the workflow automatically creates a “Lost Deal - Feedback” task, reminding the deal owner to follow up with the customer to get feedback, and for future opportunities.

The criteria_details defines which records the workflow applies to. In this case, the rule applies to the records that satisfy the following conditions:

1. The Amount is greater than or equal to ₹30,000, and  
   
2. 
   The Reason for Loss is “Price.”  
   

By combining these elements, this workflow achieves a full closed-loop follow-up system.

Conclusion:  

Zylker’s updated and new workflows make their automation smarter and more responsive. They are now able to spot key deals and ensure lost opportunities are revisited.  

And this is just the beginning. There are countless use cases you can build with workflows. We have included many examples in our Postman collection. Please check them out to get more out of the Workflow APIs. If you have a unique scenario you would like us to address, or a specific automation challenge you are facing, please let us know! We will address them in the upcoming weeks.

We hope you are now well on your way to mastering Workflow APIs. Share your thoughts in the comments or write to us at support@zohocrm.com.

Previous Kaizen :  Workflow APIs - Part 2 | Kaizen Directory

Additional Reading:

1. Workflow APIs - Part 1 - Auditing Workflows
   
2. Workflow APIs - Part 2 - Find out what actions and triggers are supported for each module

• Topic Participants

• Anu Abraham

  

• Sticky Posts

• Kaizen #216 - Actions APIs : Email Notifications

  Welcome to another week of Kaizen! For the last three weeks, we have been discussing Zylker's workflows. We successfully updated a dormant workflow, built a new one from the ground up and more. But our work is not finished—these automated processes are

• Kaizen #152 - Client Script Support for the new Canvas Record Forms

  Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achieved

• Kaizen #142: How to Navigate to Another Page in Zoho CRM using Client Script

  Hello everyone! Welcome back to another exciting Kaizen post. In this post, let us see how you can you navigate to different Pages using Client Script. In this Kaizen post, Need to Navigate to different Pages Client Script ZDKs related to navigation A.

• Kaizen #210 - Answering your Questions | Event Management System using ZDK CLI

  Hello Everyone, Welcome back to yet another post in the Kaizen Series! As you already may know, for the Kaizen #200 milestone, we asked for your feedback and many of you suggested topics for us to discuss. We have been writing on these topics over the

• 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.

• Recent Topics

• Delay in MX updates

  Hi, I set MX Records 12 hours ago, and I am receiving email normally, but I still get notification MX record is not pointing correctly. Error: The MX records of your domain is not yet pointed to Zoho Mail. Why there is a delay in detecting MX records,

• make.com integration

  Just wondering if anyone on Zoho One account connecting apps to Make.com We're on Canadian server (.com) and when connecting to Make.com, it keeps having error of Invalid Client ID. I have contacted both Zoho and Make and both sides said it's not an error

• Article Numbers for KB articles

  Hello, I was wondering if it's possible to turn on article numbers/ part numbering for KB articles. If this is not already a feature, we'd like to request it. Frequently a solution will require multiple articles so tracking which articles are referenced

• Refund Request ,Zoho Mail Subscription (zoho suport is not replying)

  Hi Zoho Team, I recently subscribed to the Zoho Mail yearly plan, but after evaluating it, I found that the interface does not suit my workflow. I’ve already canceled the subscription from my end. As I’m well within your 30-day refund window, I’m requesting

• File Encryption - Zoho Desk iOS app update

  Hello, Everyone! We have now introduced the 'File Encryption' option within the Zoho Desk app as part of the HIPAA Compliance. This option allows the user to encrypt the attachments within the Desk mobile app, which acts as an additional layer of security.

• Data encryption - Zoho Desk iOS

  Hello, Everyone! In the recent iOS version(v2.8.23) of the Zoho Desk app, we have supported data encryption. As a part of HIPAA Compliance, the Zoho Desk mobile app now allow users to encrypt the Desk mobile database as an additional layer of security.

• Notify Admin when a user forgets to check-in or check-out at the designated time.

  Hello, I would like notify the Admin via email when a user forgets to check-in or check-out at the designated time. What is the best way to setup this email notification?

• Assistance Needed with Prospect Conversion Issue

  Hi, I attempted to convert a prospect to an account, but received a pop-up notification indicating that the contact information matches an existing contact. I selected the option to add it to the existing contact, but it appears the prospect was not successfully

• Mail Merge - unable to send more than 50 email

  Hi, I've subscribed to the pay email service because of the Mail Merge feature. However, I've found that this feature only allow to send up to 50 emails. I've to attach a screenshot for your reference. This limitation is not mentioned anywhere in service.

• Zoholics Europe 2025: Your Ultimate Data Analysis (Zoho Analytics) Workshop Experience

  Why should you attend? This year, Zoholics Europe 2025 is putting data analysis centre stage. With a dedicated workshop designed to answer all your data-related questions, you’ll gain practical skills, real-time solutions, and expert insights that you

• UK payroll entries

  Hey guys, Nett payroll payments are imported direct into the bank, using an external payroll system (will be glad for Zoho to have a UK payroll app) At present I have monthly recurring bills for HMRC which are auto entered & paid when due. This seems

• Invoice status on write-off is "Paid" - how do I change this to "Written off"

  HI guys, I want to write off a couple of outstanding invoices, but when I do this, the status of the invoices shows as "Paid". Clearly this is not the case and I need to be able to see that they are written off in the customer's history. Is there a way

• Reverse Charge Services (Non-EU) Showing Correctly in 84/85 and 67, But Missing in Box 46 - Germany

  Hi, I'm located in Germany and I’ve set up my expenses for non-EU services (e.g., OpenAI, DeepSeek) under the reverse charge mechanism (§ 13b UStG) in Zoho Books, and I noticed some discrepancies in the VAT Summary Report. What’s Correct: Reverse Charge

• Zoho Live Chat/Support

  What is going on with Zoho support lately? I've tried to use the live chat feature 4 different times and it refuses to connect to any (despite waiting over 30 minutes one of the tries). I finally gave up and emailed my question nearly a week ago and still

• Can we have a module to records Certificate No and TDS rates for Lower TDS Certificates by the vendors ?

  Can we have a module to records Certificate No and TDS rates for Lower TDS Certificates by the vendors ?

• Tip #38- Track Organizational Changes: A Guide to Using Action Log Viewer- 'Insider Insights'

  Hello Zoho Assist Community! Ever needed to trace who did what and when within your remote support operations? Let’s say your support team is growing, and you want to monitor key activities like settings updates, user invites, module changes, or permission

• Tip of the Week #67– Avoid confusion – Mark duplicate threads.

  When customers send the same message to multiple email addresses, such as support@ and sales@, your team may end up seeing the same message in different inboxes. This creates confusion, risks double replies, and clutters your workspace. Use the Mark as

• Tax in Quote

  Each row item in a quote has a tax value.  At the total numbers at the bottom, there is also a Tax entry. If you select tax in both of the (line item, and the total), the tax doubles. My assumption is that the Tax total should be totalling the tax from

• Final Reminder: Discontinuation of Older ASAP Widgets and Mobile SDK Support

  We launched the new ASAP Help Widget last year, introducing a unified and enhanced experience. Since then, older configurations have been placed in read-only mode, with all major updates and improvements built exclusively on the new version. As part of

• Zoho Subscriptions -- Zoho Commerce integration

  Is there integration between Zoho Subscriptions and Zoho Commerce? I would like to create subscription plans in Zoho Subscritpions and list them for on my Zoho Commerce store.

• Website show Blank white screen

  Customer called me to tell me my website is currently down upon review it shows a white screen however I can access everything via editor. JITCADCAM.com

• How manufacturing analytics can transform your enterprise with Zoho Projects Plus

  Did you know that every single car is made up of 30,000 to 40,000 individual parts? All of these are manufactured meticulously in various facilities before being assembled into one. The global manufacturing industry spans a wide range from delivering

• Projects custom colors replaced by default orange

  Since yesterday, projects uploaded to Zoho, to which I had assigned a custom color, have lost the customization and reverted to the default color (orange). Has anyone else had the same problem? If so, how did you resolve it?

• Customize your SalesIQ live chat with Custom CSS and blend it with your website design

  Hi everyone. Hope you all are having a great day! SalesIQ offers various inbuilt customization choices for your chat widget and window like changes in colour, theme, font etc. Although these choices are many, sometimes they may not match with the design

• From Email Address When Replaying to Missed Chats

  One of the most common things we do is follow up on every missed chat.  Missed chats are like money in the bank, people just waiting for your response and to start a relationship with our companies. However, SalesIQ only lets you respond from 1 email address from your entire account?! We have happily paid for 4 subscriptions, but our users cannot reply from their own email address?  How are we supposed to build customer relationships? The fix to this issue is so simple, just load in the logged in

• how to treat a same person as customer and vendor in zoho

  hi team, in my company, few persons acting as creditors as well as debtors (which means sometimes we pay them... some times we paid by them). in that case i would like to maintain a same ledger for that person.in zoho books it is treating creditor and

• Narrative 6 - The impact of rebranding

  Behind the scenes of a successful ticketing system - BTS Series Narrative 6 - The impact of rebranding Every organization has invested in branding to set itself apart, and that should be reflected in the help desk. Zoho Desk enables organizations to apply

• custom color palette for picklist in Sheet

  Migrating over from Google Sheets and missing the ability to customize the individual item colors of my picklist/dropdown menus. Is this something that is possible? A search showed me creating a custom color palette in Analytics is possible but I am not

• What's New - July 2025 | Zoho Backstage

  Start smart, end strong. From knowing who’s coming to celebrating who showed up, July’s updates help you run events that feel organized from the first invite to the final thank you. Planning an event used to be like writing a choose-your-own-adventure

• Image Upload Field API get encrypted ID and sequence number

  Hello is there a way to extract the encrypted id and sequence number from image upload fields through the Zoho CRM API? I created a custom script with javascript within Zoho CRM, but I want to extract the encrypted id and sequence number for all my images

• Attention: Changes to 10DLC TCR pricing and new authentication requirements

  Hi everyone, Starting August 1, 2025, The Campaign Registry (TCR) is introducing new pricing changes and a mandatory brand verification process called Authentication+ 2.0, which will affect how you register and manage your 10DLC messaging services. These

• Better Time Tracking

  We need better time tracking customization for IT MSPs. We also need reporting that is built in, rather than having to try and fumble with creating custom reports. We also need to be able to mark whether a ticket has been billed or not, I don't think

• Scheduled Tickets Need Updated

  There is a very clunky manual way to create reoccurring scheduled tickets. This should be created to be easy for the administrator to create. We create several (10 to 12) reoccurring tickets per account for biweekly and monthly auditing purposes.. The

• Team Feeds Improvements

  Team Feeds needs to show a feed of every action within the department. Currently it seems that the feed will only show a ticket that I've personally commented on or interacted with/followed. A feed should be that, a feed. As a manager I would like to

• Better Security, Better User Experience | Help Center Update | June'25

  As part of our commitment to enhancing user experience and security, we are happy to announce updates to our authentication mechanism. This update introduces several key enhancements designed to improve the password recovery process and streamline the

• Upload Logo to Account Page

  It would be nice to set a logo for an Account

• View Agent Collision on Ticket List Page

  It would be nice from the ticket listing page (views) to see what agents are working on what tickets rather than having to click into each ticket throughout the day to see what agents are working on what tickets. This functionality would also be desired

• Restrict user from viewing the detail standard view

  Is there any way to restrict a user(it can be user-field-based) from viewing the detail standard view? Basically, I have created a canvas detailed view so that on some conditions I can hide some data from the users but the standard view client script

• Upload Picture to Contact

  It would be nice to upload a profile picture to a contact.

• Allowing Pictures for Client Contacts

  Do you have any plans to allow us to add pictures of our client contacts? There is a silhouette of a person there now, but no way that I can see where I can actually add a picture of the individual.

• Next Page