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 Amount is greater than or equal to ₹30,000, and
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.
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.
Additional Reading:
- Workflow APIs - Part 1 - Auditing Workflows
- Workflow APIs - Part 2 - Find out what actions and triggers are supported for each module
Topic Participants
Anu Abraham
Sticky Posts
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.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 thisKaizen #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 howKaizen #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
Recent Topics
issue with deluge script
i used chat gpt to build this script and I am getting 2 errors which I cannot figure out how to fix: void monthly_sales_order_generation() { try { // ---------------- CONFIG ------------------- analytics_url_1 = "https://analytics.zoho.com/api/<workspaceID>/report/<reportID1>/data";Introducing LinkedIn Apply Connect for Zoho Recruit
Attract up to 3x more qualified candidates and hire more efficiently with LinkedIn Apply Connect. Let candidates fill-in job applications without any redirections, gain deeper insights with applicant highlights within Zoho Recruit, and keep candidatesRecruit paid support?
Hi all, Could anyone who has paid support package advise if it provides value for money with regards to support response times? Exploring the idea as unfortunately when we have faced issues with Recruit it has been a 7+ day timescale from reporting toTicket Status email
Good day, This was discussed in the past, but it would be helpful if we could have the system assign a custom response to a status. We have various statuses for tickets, e.g. "closed due to no response", or "Pending Status", it would be helpful for theFuture Orders - Due Date
Hi In my role, I can receive tickets where the work required is requested months in advance. Using a Future Orders option, which I believe was setup under the On Hold status type, hides the Due Date, in all views/ticket etc. Whilst I understand the reasoningIntroducing Withdrawal Reasons for Offers
We’re excited to introduce a new enhancement to the Offer module that brings more clarity and accountability to every withdrawn offer. The Withdrawal Reason update ensures that each withdrawal — manual or automatic — is backed by a clear explanation,Zoho Creator customer portal users
Hi, I'm in a Zoho One subscription with our company. I'm running a project now that involves creating a Zoho Creater application and using the Zoho Creator Customer Portal. At most we need 25 customer portal users. In our Zoho One plan we only get 3GPS tracking only or Check out facility
Dear Team, Zoho CRM is quite robust CRM but till date i was waiting for the feature of having GPS tracking of Sales employees which is a common demand by all customers for thier field sales executives. We cover them by saying that CRM provides CheckinAppraisals on Employee Information Profile
Is it possible to show completed appraisals on each employee's "Employee Information" page? I would presume at the bottom - similar to the "Related Lists" concept in Zoho CRM. Obviously view access would be limited to employee and appropriate other rolesKaizen #220: Actions API - Webhooks APIs - Part 2
Hello all!! Welcome back to the follow-up Kaizen post of Kaizen #219: Actions API - Webhooks APIs - Part 1. In the previous week, we covered how to configure a basic Webhook and how to include Headers, Body, and URL Parameters using both the POST WebhookStandard Payment Term is not pulled from account to quotation
Hey Team There seems to be something off. I do have "Net 30" as my default payment term in Zoho Books for my customers. If, from the customer overview or quote section, I create a new Quotation, the payment terms field stays blank and doesn't get theManage your invoices from Bigin's mobile app (iOS)
Hello everyone! We're happy to announce that users can now integrate Zoho Books with the latest version of Bigin's iOS app. Zoho Books can be integrated with Bigin only via the web application. Users can view the Zoho Books tab in the detail pages ofSystematic SPF alignment issues with Zoho subdomains
Analysis Period: August 19 - September 1, 2025 PROBLEM SUMMARY Multiple Zoho services are causing systematic SPF authentication failures in DMARC reports from major email providers (Google, Microsoft, Zoho). While emails are successfully delivered dueAccessibility controls and multilingual captcha authorization for Help Center users
Hello everyone, As part of our ongoing effort to improve user experience, we are excited about the accessibility controls and predefined accessibility personas added in the Help Center, similar to what is already available in Zoho Desk. Help Center usersZoho Sign + Zoho CRM : la solution pour simplifier vos accords de vente
La conclusion d’un contrat de vente nécessite de nombreuses étapes : préparation de documents, validations successives et collecte des signatures. Les équipes commerciales passent souvent par plusieurs cycles de collaboration et de révision, tout en assurantItem/service subtotal
Just discovered & really pleased that we can drag to re-order the line items in Sales orders & Invoices, a very nice feature which doesn't seem to be documented? It would be nice to be able to insert a subtotal as a line item to complete this great featureSend email template "permission denied to access the api"
Hello, Per the title, I'm trying to send a Zoho CRM Email template based on the advice given here: https://help.zoho.com/portal/en/community/topic/specify-an-email-template-when-sending-emails-in-custom-functions (I'd prefer to send right from Delugehow to Solve Conflict Invoices in Zoho POS
Hello Team, I am facing a repeated issue in Zoho POS while saving a sale that contains service-based items. My products are intentionally created as Service (Non-Inventory) items because I do not want to track stock for them. However, every time I tryCopy, Paste, Highlighted text
when i copy paste text it gets highlighted. Fix this. WTF is with this black highlight ? Fix copy pasting. Some people pay for using this mail service.Pricing Strategies: #6 Common Mistakes while Configuring Pricing
"Why does this month's billing feel messy again?" That was the exact line Priya muttered while staring at the spreadsheet full of edited pricing, one-off discounts and mismatched subscription details. Her business was growing, but the pricing machinePublish to LinkedIn via API
Hi, Is it possible to publish a job opening to LinkedIn (paid job slots) if creating a job opening via api / deluge function? Or is the user required to manually publish via the job boards process? Many Thanks AdrianFSM - Associating and selecting Contacts based on Service Addresses
Hi FSM team, I've come across an FSM limitation I wanted to share for improvement. I'm currently configuring FSM for a client who provides heating system install and maintenance services. The are often sub contracted by building management companies toDo Unpublished Products in Shopify Sync to Zoho POS?
Will an unpublished product in Shopify sync to Zoho POS? I would like to know how Zoho POS handles products that are in draft/unpublished status in Shopify.Problem in Zoho POS frontend ERP.
We are facing some difficulties in our billing and inventory processes and require your support to resolve them at the earliest. Customer Advance Payments We receive advance payments from customers for upcoming sales. Please guide us on how to recordCategorize Items with Item Headers
Hello customers, Did you ever want to classify items based on specific categories to help your customers understand your invoice better? With the new Item Header feature, you can easily categorize items in your invoices and estimates and give them a common title. Item Headers are available in the Invoices, the Recurring Invoices and the Estimates module. It can be carried forward from estimates to invoices at the time of converting the estimates. To add an item header: Go to the Estimates, InvoicesDiscount on the transaction level in POS
"Is it possible to apply a discount on the total bill before tax in Zoho POS?" I want to apply a discount on the total transaction amount in Zoho POS, but the discount should be calculated before the taxes are applied. Is there an option to do this inSend Automated WhatsApp Messages and Leverage the Improved WhatsApp Templates
Greetings, I hope all of you are doing well. We're excited to announce a major upgrade to Bigin's WhatsApp integration that brings more flexibility, interactivity, and automation to your customer messaging. WhatsApp message automation You can now useJobs at multiple locations
Hi A lot of times we have same job open at multiple locations. So I would like an option where we can create a job and choose multiple locations. Currently we have to create individual jobs for each location. If we can create one job and mention multipleTag Adding Option in Kanban Card Customization Bigin CRM Mobile App
I would like to request an option to add and display tags on Kanban cards in the Bigin CRM mobile app. This feature would make it easier to categorize deals and quickly identify priorities while working on the go.Empowered Custom Views: Cross-Module Criteria Now Supported in Zoho CRM
Hello everyone, We’re excited to introduce cross-module criteria support in custom views! Custom views provide personalized perspectives on your data and that you can save for future use. You can share these views with all users or specific individualsAssociating a Candidate to a Job Listing
Hello, I am trying to use Zoho Forms embedded on my website for candidates to apply for a job opening. I want the form then to tie directly with zoho recruit and have the candidate be automatically inputed into Recruit as well as associated with the specificWhatsApp Voice Message Sending Option in Bigin CRM
I would like to request a feature that allows users to send WhatsApp voice messages directly from Bigin CRM. This would help improve communication efficiency and make it easier for teams to respond quickly to customer inquiries.CRM: hosting a single html file in Zoho and displaying it as a widget
I have seen that CRM offers the option of uploading a web project to Zoho itself and displaying it as a widget in CRM. The instructions then talk about setting a development environment with Node and developing an application to upload to Zoho. But IHow to change position button transtition of Blueprint?
Hi Everyone, Look at my screenshoot, it is possible move the reject button to the right? I couldn't find that setting in the blueprint. Thank you.Multi file upload
Hi, I just wonder if one could upload multiple files in one shot, say between one and three files, without adding multiple File Upload fields? Thanks, AlalbanySorting Descending in a lookup
I have a case number lookup on multiple forms. I need the most recent added to appear at the top of the lookup or as the list of cases grom it's too much to scroll. Is there a way to have a look up sort descending?Auto-upload Creator Files to WorkDrive
Hi everyone, I’m working on a workflow that uploads files from Zoho Creator to specific subfolders in Zoho WorkDrive, as illustrated in the attached diagram. My Creator application form has two multi-file upload fields, and I want—on successful form submission—toAsap Widget 2.0
Where's the documentation for the new ASAP widget? https://www.zoho.com/desk/developers/asap/#introduction this one is outdated How can we dynamically navigate between different views? How can we prefill ticket forms using ASAP 2.0?Can the Trigger be changed?
I'm afraid I already know the answer, but here goes... After activating a workflow (under Campaigns > Automations), Then later choosing to Edit the workflow, Can the Workflow's Trigger be changed? Currently the entire Trigger section + options are goneMarketer's Space: Proven tips to improve open rates – Part I
Hello Marketers! Welcome back to another post in Marketer's Space! In this week's post, we'll discuss the ever-important concept of open rates. This will be a multi-part series, as we have a range of topics to cover. Open rates—which measure the percentageNext Page