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 #226: Using ZRC in Client Script

  Hello everyone! Welcome to another week of Kaizen. In today's post, lets see what is ZRC (Zoho Request Client) and how we can use ZRC methods in Client Script to get inputs from a Salesperson and update the Lead status with a single button click. In this

• Kaizen #222 - Client Script Support for Notes Related List

  Hello everyone! Welcome to another week of Kaizen. The final Kaizen post of the year 2025 is here! With the new Client Script support for the Notes Related List, you can validate, enrich, and manage notes across modules. In this post, we’ll explore how

• Kaizen #217 - Actions APIs : Tasks

  Welcome to another week of Kaizen! In last week's post we discussed Email Notifications APIs which act as the link between your Workflow automations and you. We have discussed how Zylker Cloud Services uses Email Notifications API in their custom dashboard.

• 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

• Recent Topics

• Ability for admin to access or make changes in zoho form without asking for ownership

  Currently in zoho form only form owner can make the changes in the form and if someone else has to make changes then we have to transfer the ownership to them and even admin also cant access it . So i think admin must have the ability or option to access

• Issue with WhatsApp Template Approval and Marketing Message Limit in Zoho Bigin

  We are facing issues while creating and using WhatsApp message templates through Zoho Bigin, and we request your clarification and support regarding the same. 1. Utility Template Approval Issue Until December, we were able to create WhatsApp templates

• Zoho CRM Calendar View

  Hello Zoho team, We need desperately a calendar view next to list, kandan and other views. I think it should be easy to implement as you already have the logic from Projects and also from Kanban View in CRM. In calendar view when we set it up - we choose

• Camera

  I can sign on to a meeting and see the other participants, but my screen is dark. The instructions for Zoho "Camera Settings" say "click on lock icon in address bar," but I don't see that icon! Suggestions?

• What is Workqueue and how to hide it?

  Hi， My CRM suddenly have this "Workqueue", may I ask how to set the permission of this tab?

• Batch/lot # and Storage bin location

  Hi I want to ask for a feature on Zoho inventory I own a warehouse and I've gone through different management software solutions with no luck until I found Zoho, it has been a game changer for my business with up to the minute information, I'm extremely happy with it. It's almost perfect. And I say Almost because the only thing missing for me (and I'm sure I'm not alone) is the need of being able to identify the lot number of my inventory and where it is located in the warehouse. Due to the nature

• Adding Sender Address with Basic Plan

  According to the knowledge base, I should be able to add Sender addresses with the Basic Plan. But whenever I try to add an email, it takes me to a search window and I cannot find any emails in the list. Even mine, which is the admin. email.

• Conditional Field Visibility in Bigin CRM

  I would like to request support for conditional field visibility within Bigin CRM. This feature should allow administrators to configure show/hide rules for fields based on predefined criteria (e.g., field values, picklist selections, stage changes,

• Bill automation in Zoho Books

  Hi I am looking for 3rd-party options for bill automation in zoho which are economical and preferably have accurate scanning. What options do I have? Zoho's native scanning is a bit pricey

• Reporting Tags

  We've been using reporting tags for years (before itemizing was available) and now we are finding reporting these tags are impossible to track. Reports have changed in the customization and our columns of reporting tags no longer show up. We do not use

• Function #53: Transaction Level Profitability for Invoices

  Hello everyone, and welcome back to our series! We have previously provided custom functions for calculating the profitability of a quote and a sales order. There may be instances where the invoice may differ from its corresponding quote or sales order.

• Consumption based inventory

  I am currently using Zoho Books for my hospitality business, which includes lodging and restaurant services. We purchase many items in bulk for storage and consumption as needed. I'd like these items to be recorded as inventory when purchased and categorized

• Smarter Access Control: Role-Based Access vs. Responsibility-Based Profiles

  Every business has roles, responsibilities, and workflows. While roles help define structure, responsibilities within those roles are rarely the same. As your team grows, some members need access to only a specific set of features. Others require visibility

• Partner with HDFC And Sbi Bank.

  Hdfc and sbi both are very popular bank if zoho books become partner with this banks then many of the zoho books users will benefit premium features of partnered banks.

• API in E-Invoice/GST portal

  Hi, Do I have to change the api in gst/e-invoice portal as I use zoho e books for my e-invoicing. If yes, please confirm the process.

• Member role in zoho meeting

  does a user with member role can see other users in the organization

• How to post more than 4 Images on Instagram?

  Hi I read several articles to the topic od how to post more than 4 images on instagram, but i can't figure out how it works. I can't find the content editor and i installesd the z share extension for google chrome. Could someone please help me? Than

• Clone Recurring Expenses

  Our bookkeeping practices make extensive use of the "clone" feature for bills, expenses, invoices, etc. This cuts down significantly on both the amount of typing that needs to be done manually and, more importantly, the mental overhead of choosing the

• Zoho Books - How to Invoke a Custom Function in Schedulers

  We have multiple schedulers that send emails to customers in batches. Currently, we are maintaining the same code across several schedulers. Is it possible to use a custom function inside a scheduler script? If yes, how can we invoke the custom function

• Special characters (like â, â, æ) breaking when input in a field (encoding issue)

  Hey everyone, We are currently dealing with a probably encoding issue when we populate a field (mostly but not exclusively, 'Last Name' for Leads and Contracts). If the user manually inputs special characters (like ä, â, á etc.) from Scandinavian languages,

• Set Custom Icon for Custom Modules in new Zoho CRM UI

• Portals-Adjust Column Sizes

  I am trying to adjust the column widths in Portals tabs. Columns that don't need to be wide are wide and longer ones are very short. I thought adding more to the digits box in Edit would widen them, but it doesn't. Anyone know how to adjust these?

• All new Address Field in Zoho CRM: maintain structured and accurate address inputs

  The address field will be available exclusively for IN DC users. We'll keep you updated on the DC-specific rollout soon. It's currently available for all new sign-ups and for existing Zoho CRM orgs which are in the Professional edition. Latest update

• is there any way to change the "chat with us now" to custom message?

  is there any way to change the "chat with us now" to custom message? I want to change this text

• Notes badge as a quick action in the list view

  Hello all, We are introducing the Notes badge in the list view of all modules as a quick action you can perform for each record, in addition to the existing Activity badge. With this enhancement, users will have quick visibility into the notes associated

• Is Zoho Live Chat compatible with WordPress CMS?

  Hello, I have a website called www.jjrlab.com and I'm interested in using Zoho Chat on it. Does it support WordPress CMS? Thanks.

• Introducing spam detection for webforms: An additional layer of protection to keep your Zoho CRM clean and secure

  Greetings all, One of the most highly anticipated feature launches—Spam Detection in webforms—has finally arrived! Webforms are a vital tool for record generation, but they're also vulnerable to submissions from unauthenticated or malicious sources, which

• Bring your CRM and Desk app inside SalesIQ with widgets

  Have you ever been confused and frustrated with multiple open tabs and switching back and forth from SalesIQ to other apps to perform your business-specific operations? How effective would it be to have all the required tools and data of the apps you

• Speak Your Customers' Language: SalesIQ's chatbots now support 30 languages 🤖

  We're unveiling some major upgrades to our chatbot that are set to revolutionize your experience! Now SalesIQ support 30 languages for both Zobot and Answer bot. By speaking your customers' language, you can enhance engagement, improve customer satisfaction,

• record submitted from creator and invoice is creating in books , but the workflow of books is not tiggering on create of record in books

  record submitted from creator and invoice is creating in books , but the workflow of books is not tiggering on create of record in books headermap = Map(); headermap.put("X-ZOHO-Execute-CustomFunction","true"); response_inv = invokeurl [ url :"https://www.zohoapis.com/books/v3/invoices/fromsalesorder?salesorder_id="

• Repeat Column merge in ZOHO writer columns doesn't allow to set max columns per row

  I'm using ZOHO writer to merge data from a ZOHO CRM subform and I want it to make a table. We're using Insert Table for Column Repeat, because this is what we need. (Name of column (Teamname) and underneath that a list of names of teammembers). It works

• Persisting email signals to contact timeline?

  Hello there. Regarding the email signals that are logged when a contact opens an email, am I correct that these signals are not logged to a contact's timeline? Ideally, I would like to have this context available for future follow-ups, if the contact

• Trouble with using Apostrophe in Name of Customers and Vendors

  We have had an ongoing issue with how the system recognizes an apostrophe in the name of customers and vendors. The search will not return any results for a name that includes the mark; ie one of our vendors names is "L'Heritage" and when entering the

• Really want the field "Company" in the activities module!

  Hi team! Something we are really missing is able to see the field Company when working in the activities module. We have a lot of tasks and need to see what company it's related to. It's really annoying to not be able to see it.🙈 Thx!

• Long table name (sync from Zoho Creator)

  Dears, How can I remove the suffix in parentheses? These tables are synced from Zoho Creator and are treated as system tables, so their names cannot be changed. This issue makes the aggregation formulas look awful.

• Unable to Assign Multiple Categories to a Single Product in Zoho Commerce

  Hello Zoho Commerce Support Team, I am facing an issue while assigning categories to products in Zoho Commerce. I want to assign multiple categories to a single product, but in the Item edit page, the Category field allows selecting only one category

• Upcoming update to Google Drive integration in Zoho Creator

  Hello everyone, We're writing to inform you about an upcoming update to how Zoho Creator integrates with Google Drive. In Zoho Creator, during actions like importing files to create an app or attaching files to fields, you can choose files directly from

• Managing Scheduled Replies

  Communication is most effective when the intended message reaches the right person at the right time. However, this can be challenging when communication occurs across different time zones. By scheduling replies, businesses can ensure that responses reach

• Show price book list price

  When using price books, once you add products to the price book in the Products related list you can display the Unit price which is the default list price; however, there is no option to show the price book list price. To see the price book list price

• Allow Attaching Quartz Recordings to Existing Zoho Support Tickets

  Hi Zoho Team, We would like to request an enhancement to how Zoho Quartz recordings integrate with Zoho Support tickets. Current Behavior: At the moment, each Quartz recording automatically creates a new support ticket. However, in many real-world scenarios:

• Next Page