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. In this post, we will discuss the Automation Tasks API.
Zylker's admin have set up the email notification that notifies the team for different triggers. Team is notified when a deal is lost. But then, what should be the course of action? Does someone know to follow up? Is the reason for the loss being logged? Often, notifications create awareness but not accountability. That is the significance of tasks. Including Task details to Zylker's dashboard ensure the right people receive the right instructions.
This update to the dashboard will allow system admins to:
- audit the existing tasks,
- create new tasks,
- update existing tasks, and
- clean up inactive and unwanted tasks.
STEP 1: Discover and audit existing tasks
To get details of existing tasks in the system and audit them the admins at Zylker use GET Automation Tasks API.
Request to fetch all automation tasks:
GET {api-domain}/crm/v8/settings/automation/tasks
Request to fetch a specific automation task:
GET {api-domain}/crm/v8/settings/automation/tasks/{task_ID}
Zylker's admin has created an automation task for investigating the reason behind a lost deal. Below output JSON shows the details of the automation task such as name, id. Note that whenever an automation task is created in the system a new task is created in the task module.
{ "tasks": [ { "created_time": "2025-11-07T12:29:18+05:30", "lock_status": { "locked": false }, "editable": true, "module": { "api_name": "Deals", "id": "5843104000000002181" }, "related_module": null, "deletable": true, "source": "crm", "created_by": { "name": "Patricia Boyle", "id": "5843104000000424672" }, "notify": false, "feature_type": "workflow", "field_mappings": [ { "display_value": "Investigate loss reason for ${Deals.Deal Name}", "field": { "api_name": "Subject", "id": "5843104000000002271" }, "type": "merge_field", "value": "Investigate loss reason for ${!Deals.Deal_Name}" }, { "display_value": "Trigger Date plus 3 day(s)", "field": { "api_name": "Due_Date", "id": "5843104000000002273" }, "type": "execution_time", "value": { "period": "days", "unit": "3", "trigger_field": "${CURRENTTIME}", "sign": "plus" } }, { "display_value": "Patricia Boyle", "field": { "api_name": "Owner", "id": "5843104000000002269" }, "type": "static", "value": { "name": "Patricia Boyle", "id": "5843104000000424672" } }, { "display_value": "Not Started", "field": { "api_name": "Status", "id": "5843104000000002279" }, "type": "static", "value": "Not Started" }, { "display_value": "Highest", "field": { "api_name": "Priority", "id": "5843104000000002281" }, "type": "static", "value": "Highest" } ], "modified_time": "2025-11-07T12:29:18+05:30", "associated": true, "modified_by": { "name": "Patricia Boyle", "id": "5843104000000424672" }, "name": "Investigate loss reason for ${Deals.Deal Name}", "id": "5843104000006662001" } ] } |
This task makes sure that the reason for loss is properly analyzed and logged. This ensures that the same mistakes are not repeated and corrective action can be taken.
STEP 2: Create new automation task
At any company, proactive engagement with customers is crucial for customer retention, especially when they are new. At Zylker, the management decided to check in with the customer after 30 days of onboarding. The admin created an Automation Task to engage with the customer using the Create Automation Task API.
Request to create an automation task for a follow up task:
POST {api-domain}/crm/v8/settings/automation/tasks
|
Key fields
- name : indicates the name of the automation task
- module: indicates the module for which the automation task is created
- field_mappings: consists of the field mappings of the fields to a record in tasks module. This consists of three main keys:
- field: indicates the API name and ID of the field in the Tasks module records
- value: indicates the value of the field in the Tasks record
- type: denotes the type of value. The possible values for this field are merge_field, static, execution_time
For the field `Due_Date`, type is `execution_time` and value is `Account Created Time + 30 Days` as:
"value": {
"period": "days",
"unit": "30",
"trigger_field": "${!Accounts.Created_Time}",
"sign": "plus"
}
It forms the core of our solution to create a task 30 days after onboarding.
This ensures customer success team automatically follow up with new customers after their first month. It helps them to:
- measure product adoption,
- gather early feedback,
- identify potential issues, and
- strengthen customer relationships.
The task is automatically created, assigned, and scheduled without manual intervention.
STEP 3: Updating an automation task
After using the customer success check-in for a while, the customer success gave their feedback to admin. They feel that the 30 day follow up is too soon and assigning the task as Highest priority is overwhelming.
The admin updates the automation tasks to accommodate their feedback using the Update Automation Tasks API.
Request to update an automation task:
PUT {api-domain}/crm/v8/settings/automation/tasks/5843104000006646001
{ "tasks": [ { "field_mappings": [ { "field": { "api_name": "Due_Date", "id": "5843104000000002273" }, "type": "execution_time", "value": { "period": "days", "unit": "60",//Changed from 30 to 60. "trigger_field": "${!Accounts.Created_Time}", "sign": "plus" } }, { "field": { "api_name": "Priority", "id": "5843104000000002281" }, "type": "static", "value": "High"///Changed from Highest to High. }, { "field": { "api_name": "Description", "id": "5843104000000002291" }, "type": "merge_field", "value": "60-day follow-up with ${!Accounts.Account_Name}.Check adoption metrics and gather feedback."// Description changed to account for the update to the task. } ] } ] } |
The admin has changed the execution time to `Account Created Time + 60 Days`, the priority from `Highest` to `High` and also the description to reflect the change in execution time.
STEP 4: Deleting tasks notifications
Any unwanted or redundant task can be deleted using Delete Automation Tasks API.
Request to delete an automation tasks:
DELETE {api-domain}/crm/v8/settings/automation/tasks/5843104000006678001
DELETE {api-domain}/crm/v8/settings/automation/tasks?ids=5843104000006646001,5843104000006646002
We hope that you find this post on Actions - Tasks APIs useful. If you have any feedback, please let us know in the comments, or reach out to us via support@zohocrm.com.
Topic Participants
Mable Mary M P
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
Live Webinar: Optimizing back-office operations in the manufacturing industry to maximize profitability
Hello everyone, We’re excited to invite you to our upcoming live webinar on February 6! Discover how Zoho WorkDrive can help manufacturing businesses optimize back-office operations, improve efficiency, and boost profitability. Our product experts willLive webinar: 2024 recap of Zoho WorkDrive
Hello everyone, We’re excited to invite you to our year-end live webinar! This session will take you through the transformative features and updates we’ve introduced in Zoho WorkDrive this year, helping you streamline document management like never before.Live webinar: Explore WorkDrive's seamless integrations with key Zoho apps
Hello everyone, We’re excited to invite you to our upcoming live webinar, where we'll delve into the seamless integration of WorkDrive with other key Zoho applications! This is a fantastic opportunity to enhance your productivity and streamline your workflowsLive webinar: Getting the most out of WorkDrive in Zoho Workplace
Hello everyone, We’re excited to invite you to our upcoming live webinar, where we’ll explore how to maximize your use of WorkDrive as part of the Zoho Workplace bundle. This is a fantastic opportunity to elevate your productivity and streamline yourLive webinar: Mastering data migration, organization, and team collaboration
Hello everyone, We’re excited to invite you to our upcoming live webinar! Discover how to seamlessly migrate your data, optimize file organization, and boost team collaboration using Zoho WorkDrive’s powerful features. This is a fantastic opportunityJoin our live webinar: Explore the WorkDrive TrueSync application!
Hello everyone, We are thrilled to invite you to a live webinar focused on mastering the WorkDrive TrueSync application. Discover how to seamlessly sync your content between the cloud and your computer, ensuring smooth and efficient file management. OurZoho Creator customer portal limitation | Zoho One
I'm asking you all for any feedback as to the logic or reasoning behind drastically limiting portal users when Zoho already meters based on number of records. I'm a single-seat, Zoho One Enterprise license holder. If my portal users are going to add records, wouldn't that increase revenue for Zoho as that is how Creator is monetized? Why limit my customer portal to only THREE external users when more users would equate to more records being entered into the database?!? (See help ticket reply below.)Script Editor not an option
I am trying to apply a script to a sheet and Script Editor is not an option. I don't want to go outside Sheets to do this (like Creator) if it can be done inside Sheets.Envio de mails
Hola! No puedo enviar mails pero si recibirlos. No se como solucionarlo! Mi dominio es chidobebes.com.arERROR CODE :554 - Your access to this mail system has been rejected due to poor reputation of a domain used in message transfer
In my email configuration: The domain's MX Records are pointed to Zoho The domain's SPF Records have been pointed out successfully DKIM is enabled. DMARC Record is pointed for the domain. The domain name is digioorja.in. Still facing the issue of Error:This Operation has been restricted. Please contact support-as@zohocorp.com for further details
l tried to verify my domain (casalimpaeperfumada.com.br) and its shows this error: This Operation has been restricted. Please contact support-as@zohocorp.com for further details.SLOW EMAILS
Is there an issue with the Zoho server? For two days now I've been having issues with very long buffering. Please advise. Thank you.POP3 authentication error - SOLVED
Just in case others are as forgetful as me ... As Zoho has changed the POP server for personal and free organisational users, I needed to change the POP server on my email client. This failed persistently but eventually I remembered that I had chosenSolution to Import PST File into Office 365.
MailsDaddy OST to Office 365 Migration Tool is an outstanding solution to recover OST files and migrate them into Office 365 without any hassle. Using this software users can multiple OST files into Office 365 with complete data security. It offers usersAdd Zoho One Groups/Departments to Shared Mailbox Access
Hi, I hope you're doing well. Currently, in Zoho Mail, I can manually add specific users or the entire organization to a shared mailbox. However, there is no option to add Zoho One groups or departments. Feature Request: We would like the ability to assignAllow Filters with Only Special Characters in Zoho Mail
Hi Zoho Mail Team, I hope you're doing well. We have noticed that currently, Zoho Mail does not allow creating filter criteria using only special characters, such as = or #. However, there are scenarios where such a filter is necessary. For example: FilteringHow to save email as PDF?
I saw 2 previous threads about this. One is from 14 years ago. The other was closed as "answered" a year ago but the feature was never implemented: https://help.zoho.com/portal/en/community/topic/how-to-download-save-emails-as-pdf Is the "save as PDF"Flexible plans
Hi, I have a Workplace Standard subscription. On Zoho's website, it mentions that with the annual plan it's possible to have multiple plans under the same organization—for example, Workplace Standard and Mail Lite. However, I can’t find a way to do thisWeekly Tips : Teamwork made easy with Multiple Assignees
Let's say you are working on a big project where different parts of a single task need attention from several people at the same time—like reviewing a proposal that requires input from sales, legal, and finance teams. Instead of sending separate remindersCannot give public access to Html Snippet in Zoho Creator Page
Hi, I created a form in Zoho Creator and published it. The permalink works but I want to override the css of the form. (style based URL parameters is not good enough) So I created a page and added an Html snippet. I can now override the css, which isWeekly Tips : Customize your Compose for a smoother workflow
You are someone who sends a lot of emails, but half the sections in the composer just get in your way — like fields you never use or sections that clutter the space. You find yourself always hunting for the same few formatting tools, and the layout justAccounting on the Go Series-43:Enhancing Your Reporting Efficiency with Dashboard Filter State Retention
Hello everyone! Welcome back to our series on Zoho Books mobile app features. Today, we will talk about a feature that yet again helps you focus on work that really matters-Dashboard Filter State Retention. Imagine you're working on your Zoho Books dashboard,Zoho books/payroll tax payment
I accidentally made a second payment to my taxes for $300 which is reflected in my bank account and therefore on Zoho books but I can not match it to any transactions because its not reflected in payroll as a tax payment. Is there a way to add an extraI can't renew the Finance Plus subscription
I tried to renew the Finance Plus subscription but it keeps reloading the same page over and over when ever I click on "Renew Subscription" buttonEstimate vs Quote
they are different. Quote is for 1 piece price + other charges. Estimate is for total quantity to be ordered. The gross total amount of the Estimate is the amount payable. Replacing Estimate as Quote is not understandable because they are different. InAccounting on the Go Series-47: Effortless GSTIN Management- Auto Populate TaxPayer Details in Zoho Books Mobile App
Hello everyone, Welcome back! Today, we're focusing on a feature specifically designed for our Indian users in the Zoho Books-Indian edition, particularly those who deal with GST compliance regularly. We understand the importance of accurate and efficientAccounting on the Go Series-48: Enhance Accuracy with Custom Work Week Start Days in Zoho Books iOS app
Hello everyone, Welcome back! We’re here with another feature spotlight that might seem small but can have a big impact on your daily routine: setting the first day of the work week in the Zoho Books iOS app. Imagine this: You’re a business owner whoTime to Get Paid Report in ZBooks
Hello, One of our customers who has 25 different companies around the world gets 60 days to make payments. Unfortunately, the subject report does not report an average time to get paid (in days) or the ability to look at a custom period of time. CurrentlyHow to prepare a balance sheet for a company that has no operations yet?
.Project Billing Method from Zoho People
Normaly our customers use Zoho Projects to manage projects and timesheet that are being charge to the customer. Using the integration from Zoho Project we can have projects base on different billing method. For example most of our customer use HourlyZoho Books-Accounting on the Go Series!
Dear users, Continuing in the spirit of our 'Function Fridays' series, where we've been sharing custom function scripts to automate your back office operations, we're thrilled to introduce our latest initiative – the 'Zoho Books-Accounting on the Go Series'.Zoho Books | Product updates | July 2025
Hello users, We’ve rolled out new features and enhancements in Zoho Books. From plan-based trials to the option to mark PDF templates as inactive, explore the updates designed to enhance your bookkeeping experience. Introducing Plan Based Trials in ZohoZoho Books | Product updates | August 2025
Hello users, We’ve rolled out new features and enhancements in Zoho Books. From the right sidebar where you can manage all your widgets, to integrating Zoho Payments feeds in Zoho Books, explore the updates designed to enhance your bookkeeping experience.Update or Upsert Records Using Unique Custom Fields
Hello customers, We've enhanced the process of updating records via API. You can now: Update records using unique custom fields Upsert records using unique custom fields Note: Both the features are available in the Zoho Books and Zoho Inventory apps.[Webinar] Understanding the New Invoice Management Systems
Join industry expert CA Pritam Mahure as he discusses the importance of the new Invoice Management System (IMS) and its impact on taxpayers. Topics Covered: - Concept of IMS and pre-requisites - Applicability and Restrictions on Invoices/Records for IMSAccounting on the Go Series-51: Effortless Transactions: Create and Manage Directly from Uploaded Documents
Hello everyone, We’re back with another useful feature that makes working with Zoho Books even easier! This time, we’re simplifying the process of creating transactions directly from uploaded documents. Imagine you’re out meeting clients, and you receive[WEBINAR] Effortless migration to the VAT-ready South Africa edition of Zoho Books
Hello there, If you are one of our early users from South Africa using the older edition of Zoho Books, this webinar is for you! We have now launched a new South Africa edition with VAT support, to which you can migrate your existing data. Join this session,Accounting on the Go Series-52: Capture Receipts on the Go, Right from Your Lock Screen.
Hello everyone, We’re excited to introduce a feature that will make your life so much easier—especially for those constantly on the move! With iOS 18, Zoho Books now allows you to capture receipts directly from your lock screen using Locked Camera Capture.AT - Austrian Accountant familiar with ZOHO
Hello, as I have just migrated to ZOHO and unfortunately have to change my accountant next year, I am looking for an accountant (for Austria) who already has experience with Zoho or who already manages clients using Zoho books. Is there anyone here fromZoho Workflow issue
Dear Zoho Users, I have Zoho Books premium subscription, I have created a email alerts workflow for Invoices and following are the configurations for the same: 1. Workflow for Invoice module 2. Choose when to tigger - created or edited 3. Filter the triggersNext Page