Kaizen 213 - Workflow APIs - Part 1
If you have ever managed complex business processes, you know that Workflows are the quiet backbone of any well-run business process. They keep things moving; assigning owners, sending alerts, keeping deals on track, and much more. But until now, you could not manage them via APIs. That changes with the release of Workflow APIs.
In this series, we will work through a real-world scenario together, showing you how to transition from manually managing workflows to governing them using APIs. We’ll look at Zylker Cloud Services, an IT solutions provider trying to bring order to its growing CRM automations.
The use case: Scaling the sales process at Zylker Cloud Services
Zylker’s sales process touches multiple teams and modules like Leads, Deals, Calls, Appointments, etc. Over time, different team members created their own workflows. The result is familiar to anyone who has scaled fast:
Multiple versions of what should be the same process
Old, unused workflows still running.
Now, Zylker wants to bring structure and visibility to this automation sprawl. Their system administrators are building a custom admin dashboard to monitor and manage CRM workflows, without needing deep CRM expertise.
They want to:
Display a real-time list of all workflows with their status
Gain insights into workflow distribution across modules
Identify inactive or outdated workflows that may need cleanup.
However, the CRM UI only allows viewing one workflow at a time. There is no consolidated view to see all workflows, their triggers, and their status across modules. That makes auditing and governance tedious and error-prone, especially at scale.
This is exactly what the Workflow APIs solve. With this, they can:
Audit all existing workflows.
Review how and when they trigger.
Identify which modules and actions are supported before creating new rules or updating existing ones.
Update existing rules and create new rules.
Delete the rules that are no longer needed.
You can not build a dynamic admin dashboard or an automated audit system for Workflows through just clicks. But you can do this now, with Workflow APIs.
STEP 1: Discover and audit existing workflows
Before changing anything, we need to understand what we are working with. How many workflows do we have? What do they do? How many more can we create?
To get a complete inventory of Workflow rules, we can use the GET Workflow Rules API. This API returns a list of all the Workflow Rules configured for the CRM account.
Sample Request:
GET {api-domain}/crm/v8/settings/automation/workflow_rules
This initial audit acts like a master list, giving us an overall picture. It helps understand the scope of the automation landscape and identify obvious redundancies, like multiple workflows with similar names or purposes.
Sample Response:
{ "workflow_rules": [ { "created_time": "2024-01-15T14:20:30+05:30", "execute_when": { "details": { "trigger_module": { "api_name": "Deals", "id": "4876876000000002181" }, "repeat": false }, "type": "create_or_edit" }, "editable": true, "module": { "api_name": "Deals", "id": "4876876000000002181" }, "deprecated": false, "deletable": true, "description": "Alert VP of Sales for high-value opportunities", "source": "crm", "created_by": { "name": "Matthew Mayers", "id": "4876876000001360001" }, "last_executed_time": null, "modified_time": "2024-01-23T12:23:12+05:30", "name": "VP Alert - High Value Deal", "modified_by": { "name": "Matthew Mayers", "id": "4876876000001360001" }, "lock": { "locked_by": null, "message": null, "status": false }, "id": "4876876000016390024", "category": "default", "conditions": [ { "sequence_number": 1, "instant_actions": { "actions": [ { "related_details": null, "name": "VP notified", "details": { "module": { "api_name": "Deals", "id": "4876876000000002181" } }, "id": "4876876000016390063", "type": "field_updates" }, { "related_details": { "best_time": true }, "name": "High value deal alert", "id": "4876876000016390015", "type": "email_notifications" } ] }, "scheduled_actions": [ { "execute_after": { "period": "business_days", "unit": 1 }, "id": "4876876000016390074", "actions": [ { "related_details": null, "name": "Confirm VP follow-up", "id": "4876876000016390067", "type": "tasks" } ] } ], "criteria_details": { "relational_criteria": { "module_selection": null, "criteria": null, "module": null }, "criteria": { "group_operator": "AND", "group": [ { "comparator": "equal", "field": { "api_name": "Amount", "id": "4876876000000002557" }, "type": "value", "value": "50000" }, { "comparator": "equal", "field": { "api_name": "Stage", "id": "4876876000000002565" }, "type": "value", "value": "Negotiation/Review" } ] } }, "id": "4876876000016390025" } ], "status": { "active": true } }, { "id": "4876876000012015001", "name": "Lead Assignment - North Region", "module": {"api_name": "Leads"}, "status": {"active": true}, "execute_when": {"type": "create"}, "last_executed_time": "2025-10-14T11:56:20+05:30" // ... other keys omitted for brevity }, { "id": "4876876000012020001", "name": "Lead Assignment - South Region", "module": {"api_name": "Leads"}, "status": {"active": true}, "execute_when": {"type": "create"}, "last_executed_time": "2025-10-14T10:30:15+05:30" // ... other keys omitted for brevity } // ... additional workflows ], "info": { "per_page": 200, "count": 71, "page": 1, "more_records": false } } |
The response gives us a comprehensive overview of all configured workflows. For each rule, we get the metadata including its unique ID, name, description, the module it operates on, its activation status, and details about when it triggers. We also get audit information like creation timestamps and which user made changes.
Working with large results
When you have hundreds of workflows, pagination helps. The response includes an info object with pagination details:
count: The number of workflows on the current page
per_page: The maximum number of records per page (default and max is 200)
page: The current page number
more_records: Indicates if there are additional records to fetch.
If the more_records key is true, we can retrieve the next page by using the page parameter in the request.
While getting all workflows gives you the big picture, we may often want to focus on specific areas. This API offers several parameters to narrow down our search:
Parameter type | Description |
module | Filters workflows by the primary module they operate on. |
trigger_module | Filters by related modules that can trigger workflows. Use this when you want workflows that are triggered by changes in related records. |
execute_on | Filters by the specific action that triggers the workflow. |
status_active | Filters by activation status to see only active or inactive workflows. Useful for audits and cleanup operations. |
filter | Searches workflows by name using a JSON filter. |
page | Specifies which page of results to return. Use this for pagination when you have a large number of workflows. |
per_page | Limits the number of workflows returned per page. The default and maximum value is 200. |
sort_by | Sorts the workflows based on a specific field. The only supported value is modified_time. |
sort_order | Sorts the workflows in ascending (asc) or descending (desc) order. |
include_inner_details | Includes the inner details like conditions and actions of the workflows in the response. |
For example, to find all active lead workflows containing "Assignment" in their name, use:
Here is the API-call-ready version of the same, after URL encoding the filter value:
Now, if you inspect the response closely, you can see that we have two similar workflows: "Lead Assignment - North Region" and "Lead Assignment - South Region." And there is also an older workflow named "VP Alert - High Value Deal."
This workflow was created almost a year ago by a former team member, and it has not been modified for a long time. Is it still relevant? What exactly does it do? What criteria define a "high-value deal," and who exactly gets notified?
To answer these questions and understand the workflow's complete logic, we must examine it closely using the Get a Workflow API. This API returns the full configuration including all conditions, criteria thresholds, and specific actions for an individual workflow.
STEP 2: Inspect a single workflow using Get a Workflow API
Sample Request:
GET {api-domain}/crm/v8/settings/automation/workflow_rules/4876876000016390024
Here, 4876876000016390024 is the unique ID of the Workflow rule whose details we want to fetch, obtained from the response of Get all Workflows API.
Sample Response:
{ "workflow_rules": [ { "created_time": "2024-01-15T14:20:30+05:30", "execute_when": { "details": { "trigger_module": { "api_name": "Deals", "id": "4876876000000002181" }, "repeat": false }, "type": "create_or_edit" }, "editable": true, "module": { "api_name": "Deals", "id": "4876876000000002181" }, "deprecated": false, "deletable": true, "description": "Alert VP of Sales for high-value opportunities", "source": "crm", "created_by": { "name": "Matthew Mayers", "id": "4876876000001360001" }, "last_executed_time": null, "modified_time": "2024-01-23T12:23:12+05:30", "name": "VP Alert - High Value Deal", "modified_by": { "name": "Matthew Mayers", "id": "4876876000001360001" }, "lock": { "locked_by": null, "message": null, "status": false }, "id": "4876876000016390024", "category": "default", "conditions": [ { "sequence_number": 1, "instant_actions": { "actions": [ { "related_details": null, "name": "VP notified", "details": { "module": { "api_name": "Deals", "id": "4876876000000002181" } }, "id": "4876876000016390063", "type": "field_updates" }, { "related_details": { "best_time": true }, "name": "High value deal alert", "id": "4876876000016390015", "type": "email_notifications" } ] }, "scheduled_actions": [ { "execute_after": { "period": "business_days", "unit": 1 }, "id": "4876876000016390074", "actions": [ { "related_details": null, "name": "Confirm VP follow-up", "id": "4876876000016390067", "type": "tasks" } ] } ], "criteria_details": { "relational_criteria": { "module_selection": null, "criteria": null, "module": null }, "criteria": { "group_operator": "AND", "group": [ { "comparator": "equal", "field": { "api_name": "Amount", "id": "4876876000000002557" }, "type": "value", "value": "50000" }, { "comparator": "equal", "field": { "api_name": "Stage", "id": "4876876000000002565" }, "type": "value", "value": "Negotiation/Review" } ] } }, "id": "4876876000016390025" } ], "status": { "active": true } }, { "id": "4876876000012015001", "name": "Lead Assignment - North Region", "module": {"api_name": "Leads"}, "status": {"active": true}, "execute_when": {"type": "create"}, "last_executed_time": "2025-10-14T11:56:20+05:30" // ... other keys omitted for brevity }, { "id": "4876876000012020001", "name": "Lead Assignment - South Region", "module": {"api_name": "Leads"}, "status": {"active": true}, "execute_when": {"type": "create"}, "last_executed_time": "2025-10-14T10:30:15+05:30" // ... other keys omitted for brevity } // ... additional workflows ... ], "info": { "per_page": 200, "count": 71, "page": 1, "more_records": false } } |
The detailed response gives us a complete blueprint of the workflow. We can now see the exact business logic: the workflow triggers when deals are edited and meet two specific conditions; when the amount equals exactly $50,000 AND the stage is Negotiation/Review.
More importantly, we can see all the actions that execute: an immediate field update to mark deals as "VP notified," an email notification sent at the optimal time, and a follow-up task scheduled for one business day later. Here's what is really interesting about this detail; this workflow has never actually executed, despite being active for nearly a year, because the last_executed_time is null in the response.
Now we are left with some important questions. Is that $50,000 threshold too narrow? What if a $49,000 deal is just as important? And is the VP still the right person to alert? Are there additional stakeholders who should be notified beyond just the VP? These are the type of questions you can start answering once you inspect your workflows closely.
STEP 3: Check limits and distribution
Before making any changes, we must understand our automation capacity and how workflows are distributed across the organization. The Workflow APIs provide two key endpoints for this:
1. Get Workflow limits API
This API provides a comprehensive view of your organization's workflow capacity across multiple dimensions.
Sample Request:
GET {api-domain}/crm/v8/settings/automation/workflow_rules/actions/rules_count
Sample Response:
{ "rules_count": { "scheduled_actions_per_rule_limit": 5, "total_rules_limit": 2500, "active_rules_configured": 71, "rules_per_process_limit": 10, "total_actions_per_rule_limit": 50, "total_rules_limit_per_module": 125, "active_rules_limit": 2000, "total_rules_configured": 82, "active_rules_limit_per_module": 75 } } |
This response gives the following information:
Total Capacity: Zylker has a generous limit of 2,500 total workflows, with only 82 currently configured. This means that they are using just 3 percent of their total capacity.
Active Workflows: There are 71 active workflows, well below their 2,000 active workflow limit
Module-level Limits: Each module can support up to 125 total workflows, with 75 of those allowed to be active simultaneously.
Action Limits: Each condition in the Workflow can contain up to 50 total actions, with a maximum of five scheduled actions.
For Zylker, this is excellent news. Only 71 active workflows out of a 2,000 limit. This means we have substantial room for growth and can confidently create new workflows without worrying about capacity constraints.
2. Get module-wise counts API
This API tells you exactly how many workflow rules you have in each module. It shows both the total number of rules and how many are currently active. This helps you see where your automations are concentrated and where you might be missing opportunities.
Sample request:
GET {api-domain}/crm/v8/settings/automation/workflow_rules/actions/module_specific_count
Sample Response:
{ "module_specific_count": [ { "active_rules_configured": 2, "module": { "api_name": "Products", "id": "4876876000000002213" }, "total_rules_configured": 2 }, { "active_rules_configured": 2, "module": { "api_name": "Deals", "id": "4876876000000002181" }, "total_rules_configured": 2 }, { "active_rules_configured": 4, "module": { "api_name": "Contacts", "id": "4876876000000002179" }, "total_rules_configured": 5 }, { "active_rules_configured": 2, "module": { "api_name": "Appointments__s", "id": "4876876000002362026" }, "total_rules_configured": 3 }, { "active_rules_configured": 4, "module": { "api_name": "Calls", "id": "4876876000000033015" }, "total_rules_configured": 5 }, { "active_rules_configured": 43, "module": { "api_name": "Leads", "id": "4876876000000002175" }, "total_rules_configured": 51 }, { "active_rules_configured": 14, "module": { "api_name": "Emails", "id": "4876876000000014163" }, "total_rules_configured": 15 } ] } |
Looking at this response, we can see 43 active workflows in Leads but only two in Deals. This tells us that Zylker is heavily focused on lead management but might be missing opportunities to automate their sales process later in the pipeline.
Together, these two APIs give a complete picture of the automation capacity and distribution.
What's next: From understanding to action
Now that we have our foundation, we are ready to start building and refining.
In the next part of this Kaizen series, we will move from discovery to design. We’ll use the Workflow Configuration, Create, and Update APIs to standardize Zylker’s automation management, create new workflow rules, and update existing ones for consistency and efficiency.
We hope that you find this post on Workflow APIs useful. If you have any feedback, or if there are any pain-points that you would like us to address in our Kaizen series, please let us know in the comments, or reach out to us via support@zohocrm.com. We will be happy to help!
Until we meet again next Friday, Happy coding!
Topic Participants
Anu Abraham
Sticky Posts
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 areKaizen #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 achievedKaizen #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
Recent Topics
Reporting Limitation on Lead–Product Relation in Zoho CRM
I noticed that Zoho CRM has a default Products related list under Leads. However, when I try to create a report for Lead–Product association, I’m facing some limitations. To fix this, I’m considering adding a multi-lookup field along with a custom relatedSeries Label in the Legend
My legend reads 'Series 1' and 'Series 2'. From everything I read online, Zoho is supposed to change the data names if it's formatted correctly. I have the proper labels on the top of the columns and the right range selected. I assume it's something inDynamic Signature - Record owner
Hi everyone, I’m using Zoho Writer merge templates from Zoho CRM and have two questions: Owner signature: How can I automatically insert the CRM record owner’s signature in the merged document? I’m not sure where this signature is stored or how to referenceSet Warehouse based on Vendor
Greetings. I would like to set automaticaly the Warehouse based on the Vendor. Context: I am working on an adaptation of a Purchase Order to be used as a Quotation. I have defined that when a user has to raise a quote the Vendor will be "PROCUREMENT" I would like to set the Warehouse to a predefined value when "PROCUREMENT" is set as Vendor. I have tried to do with the Automation feature using the Field Update option, but Warehouse does not is listed as a field. Can you help? Thanks in advance.Printing from Zoho Creator hosted on my own server to printers hosted on my clients local network
Hello. Fairly new to Zoho Creator and looking for best options to be able to print from my application hosted on my own server to any printer hosted on my clients own local network. Any advice is welcome. Thank you.Add System Pre-Defined Lookup Field to Subform?
Hi there! New to using Zoho, so this may already exist, but I'm having trouble figuring it out. Is there a way to get the system pre-defined Account Lookup field (in our case, renamed to Company Name), as the starting point for a subform? In our company,Numbered / bullet point List in Zho Cliq
Hi, is there a way to format chat messages in Cliq like this Topic 1 Hey, I finished this project yesterday etc... Topic 2 I am still working on this etc...Cannot Access Subform Display Order in Deluge
As highlighted in this community post, we still have to deal with the significant limitation of not being able to access the user-sorted order of subform rows through Deluge. This creates a major disconnect between the UI capabilities and backend automation,How many groups in Zoho Mail can I make?
I'm currently on the free plan, which has a limit of 10 users. Does that limit includes groups too? If not, what is the limit for groups? Thanks!Feature Suggestion for Zoho Social: Auto-reply to Comments or Keywords
Hi Zoho team, I'd like to suggest a very specific feature that would be extremely helpful for customer engagement: the ability to automatically send a reply to comments on posts — either all comments or those containing specific keywords. For example,Already have Zoho account. Not letting me log in
I already have a Zoho account that is associated with my Google email and my phone number. Even though I'm already logged in to Zoho, when I click on the mail icon to access my email, it takes me to the pricing page. When I click on the free option, itZOHO Mail App Not working
There seems to be an issue with Zoho Mail App today. It is not connecting to server, internet is working fine, tried uninstalling app and reinstalling, loading circle keeps spinning round. Is there an update on the way?facing error 550 5.4.6 while sending emails
Please help me fix this issueAllow Itemization for Recurring Expenses
For whatever reason, one cannot itemize a Recurring Expense. This capability should be added. The use cases to support this are largely the same as what they were to allow for itemization in Expenses. Anything that would need to be itemized for a regularZoho reply to not working. just reply to my self
Hello. i using on my wordpress website a contact form from Wsform. i can set the reply to email there. normally it works. but since i am using your wordpress plugin zoho mail it doesn`t work. its not using the reply to (email from customer). I just canCan't receive any email from other platform
Hello,everyone, i'm just join zoho and create two email accounts for my own business. I was using it to get a verified email from stripe, but can't receive it. and I use my private gmail account to send test email twice, first time show below reply, butYour Incoming has been blocked and the emails will not be fetched in your Zoho account and POP Accounts
Can some on help me regarding our account . thank you so muchZoho Creator integration with Sage 50
Hi, Wondering if anyone has had any experience connecting Zoho to Sage 50 and could share any information on this matter. Thank you.Conditional Email Forwarding
How can I set conditional email forwarding of the users? For example: Mail should be forwarded to a address only if it comes from a particular sender. So, I want such email forwarding, which forwards mails based on particular conditions, like the incomingIncoming emails not appearing in Inbox
Hello, I have an issue with incoming emails sent from my website (domain: h2ostop.si). Emails are visible in the Sent folder, which means they are successfully sent through Zoho SMTP, but they never appear in my Inbox. Nothing arrives in Inbox, Spam,Automatic Matching from Bank Statements / Feeds
Is it possible to have transactions from a feed or bank statement automatically match when certain criteria are met? My use case, which is pretty broadly applicable, is e-commerce transactions for merchant services accounts (clearing accounts). In theseEmail Opt Out Question
Has the problem where if a customer is emailed opt out prevents you sending standard emails? For me this feature is simply to stop any email marketing and should not block people from receiving emails via Zoho mobile, which makes no sense.Can No Longer Access Zoho Email Accounts from iPhone or iPad Apple Mail Apps ,.
Keeps asking for password, Says ID or password incorrect. Tried creating a new app specific password. Same result. Is this possibly related to the server maintenance. Have verified all email settings, userid and password. This has worked for years untilLatest update caused issue in using marathi typingzoho
With latest update now marathi typing does Not work in zohonotebook. I preferred zoho over other because it was supporting marathi font without any distortion.. But after new update,keyborad simply does not workLogin verification emails never received.
I can't login to my account. You send a verification email, but it never arrives. This is a common problem, frequently caused by some relay point out there classifying the sender as a spammer. Is there anything I can do to bypass this? Maybe get a textGlobal lists for Multi select
It would be great if I could select a global list to use for a multi select dropdown filed.Yahoo is rejecting e-mails sent from a Zoho server
Diagnostic-Code: 4.7.0 [TSS04] Messages from 136.143.169.51 temporarily deferred due to unexpected volume or user complaints - 4.16.55.1; see https://postmaster.yahooinc.com/error-codes Remote-MTA: dns; mta5.am0.yahoodns.netYahoo blocks e-mail sent from Zoho servers
Getting this for a bunch of Yahoo addresses. Do you know if some of your servers got blacklisted? Diagnostic-Code: 4.7.0 [TSS04] Messages from 136.143.169.51 temporarily deferred due to unexpected volume or user complaints - 4.16.55.1; see https://postmaster.yahooinc.com/error-codesWorking with dates and Function Field
Hello friends! I'm trying to add days to a date, however the field function will always shows 00:00:00 after the resultant date. How can I display only the date, whithout the time? toDate(input.request_date.addDay(input.Prazo_acordado),"MM,d,yyyy") The code above will result something like "11-Feb-2020 00:00:00", but I want to display only "11-Feb-2020"What's New in Zoho Analytics - November 2025
We're thrilled to announce a significant update focused on expanding your data connectivity, enhancing visualization capabilities, and delivering a more powerful, intuitive, and performant analytics experience. Here’s a look at what’s new. Explore What'sUnable to send message;Reason:550 5.4.6 Unusual sending activity detected. Please try after sometime.
Please help my account got blocked automatically, can you help me how to avoid it? Thanks so muchtemporary system errorlouis
J'essaye d'envoyer des mails avec mes 2 adresses mail qe nous avons sur le compte arthur@lepunch.fr et louis@lepunch.fr mais j'ai toujours le message temporaire system error, je reçois les mails mais impossible d'en envoyer a qui que ce soitHow to Cancel/Delete Queued Mail Merge?
Hi. I just tried to do a mail merge before realizing there's a limit on number of sends. I accidentally sent one of my lists twice, and all of those emails are currently queued. Is there any way to cancel or delete a queued mail merge? Would love to beSOLVED: Stopping Multiple Invitations when sync with Google Calendar
I wanted to share this solution as I wasn't able to find it when searching through the Zoho community and via web search. The issue: When requestor books a meeting through Zoho Bookings, the requestor receives a confirmation email from both Bookings andNeed to add a new admin for my domain
Hello Zoho Support, I am the owner of the domain localeistanbul.com. The current super admin account (admin@localeistanbul.com) is not accessible. I do not want to reset or delete the existing account because I need to keep all existing emails. PleasePossible Fraud Site.
Hello. I received a text with the sender's name as zoho, claiming that my account was at risk and that I should sign in at https://verify.zohomails.ru/signin to verify my account. I signed in on the web address above, and a few days later someone hackedZoho mail to Teaminbox
Hello, We're searching for new mail program. Now I'm testing a bit with zoho mail and team inbox. My findings in the research: Pop mail throught zoho mail is almost instant. Any pop or imap via external provider takes a couple minutes to 15 minutes beforeCrear tarea CRM con recordatorio desde Zoho Flow
Hola, estoy intentando crear desde Zoho Flow una tarea en CRM. Lo he logrado hacer pero sin recordatorio, ya que no se como se debe escribir el string adecuado. He probado varias alternativas, pero ninguna me funcionó hasta ahora. - FREQ=NONE;ACTION=EMAIL;TRIGGER=DATE-TIME:${FechaVto}Inquiry Regarding Automated Assignment of Zoho TeamInbox Messages using Zoho Flow and Deluge
Hello, Our company is currently using Zoho TeamInbox, and we are interested in automating the assignment of responsible parties using tools such as ZOHO Flow and Deluge. Is it possible to achieve this? Allow me to provide more details. Currently, whenMultiple clients in one project
Hi team, What is the possibility to have more than one client to be linked for one project in the Zoho Books? Our business model is to have a project, and this project have expenses/bills, as well, we issue invoices for this same project to several customers.Next Page