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 #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
Payroll and BAS ( Australian tax report format )
Hello , I am evaluating Zoho Books and I find the interface very intuitive and straight forward. My company is currently using Quickbooks Premier the Australian version. Before we can consider moving the service we would need to have the following addressed : 1.Payroll 2.BAS ( business activity statement ) for tax purposes 3.Some form of local backup and possible export of data to a widely accepted format. Regards Codrin MitinInvalid scope choice: Workdrive integration in CRM
Bug: There is an invalid option in the permission choices for Workdrive integration in CRM. If the entry "WorkDrive.teamfolder.CREATE" is selected, it will return a message indicating invalid OAuth scope scope does not exist.What's New - February 2026 | Zoho Backstage
February 2026 brings a major new addition and a collection of enhancements across Zoho Backstage. We thought about writing a long introduction, but the updates in this release make a strong case on their own. So we’ll skip the buildup and dive straightAttaching files to emails within CRM Deals.
Hello, We have recently started using the extension "Workdrive for CRM" (Related List) to view/store our documents for each Deal, instead of using Attachments. Overall it feels like a better way to go but the user experience is not so great when it comesAnyone worked out how to export or screengrab a full heatmap?
I'd love to be able to include a copy of a heatmap in a report but can't work out how to grab the whole thing as there doesn't appear to be an export function? Thanks in advance.Establishing Relationships among contacts/leads with Reciprocal
Is there any way to create a relationship between contacts and leads and be able to go into just one of the files and have it reciprocate the entry in the other file? For example, if I have two people say John and Jane Smith who are husband and wife.Placeholder for Agent Signature in Email Templates
Dear Zoho Team, I hope this message finds you well. We currently face a limitation when designing email templates in Zoho Desk. While we can create email templates and include a footer at the end, the agent signature is always appended by default at theCustom View and Custom Fields on Zoho Books
Hi, I have some custom fields on Estimates and Invoices. I also use Custom Views so I can have a lot of information at a glance. I want to include my custom fields as columns in my custom views of estimates / invoice, but it looks like is not possible.%PaymentLink%
Does not work. Software creates a BAD link. ....and yes payment options are turned on. Link on the invoice pdf once opened will work but this template is a joke.Syncing calendar with Google Calendar doesn't work when events are sent to auto repeat
Hi... The ZOHO CRM -- GOOGLE CALENDAR sync is broken. If I create a single event on either side, sync works, but if I create an event with auto repeat on either side it doesn't work. Furthermore, events created before the sync don't show up in the calendar.Allow Global Admin to access/edit all forms without changing owners
Hi there, Please consider adding a feature where the Global Admin of the account an automatically access/edit any form in the Company Account. I'm the Global Admin on our Zoho One plan, and we have multiple users that use/create forms. But for me to accessCan Zoho Marketing Automation send OTP codes via WhatsApp during user registration?
The flow I would like to implement is: A user signs up in the mobile app and enters their phone number. The system generates a one-time verification code (OTP). The OTP is sent to the user via WhatsApp message. The user enters the code in the app to confirmWhere to show Customization Field ?
Dear Sir, I have made some New Field in Item Field Customisation. Now I don't require that field in Estimate, Sales Orders etc. I just wants that field in Sales Invoice to Show/Hide... Is that possible ?What's New in Zoho Analytics - February 2026
Hello Users! We're back with another round of updates for Zoho Analytics. This month's release focuses on giving you greater flexibility in how you visualize, manage, and act on your data - with new features like custom visualizations, remote MCP server,Zoho Books (and other Finance Suite Apps) - Clickable Item Name on Invoices and Reports
Hi Zoho Books team, It would be really helpful if the Item Name on Reports were clicable to take me to the item. The same on Invoices, often I am looking at an invoice and I want to look at the deails of a product. A link here would be helpful to jumpZOHO Reports are taking longer time to get refresh
Hi Team, Since last few days, I'm facing issues in getting updated reports. For eg: right after making an expense entry or even posting a journal, it is taking longer then expected for the updated reports. Refer below: "You are viewing the report thatDisplay actual mileage on an invoice
My users are creating expenses in Zoho expense. For example, they expense 10 miles and get paid 7 dollars (10 miles * IRS rate of .70). If I look at the expenses in Zoho Books, it does show them at 10 miles at .70 cent When I add these expense to an invoiceCan't change form's original name in URL
Hi all, I have been duplicating + editing forms for jobs regarding the same department to maintain formatting + styling. The issue I've not run into is because I've duplicated it from an existing form, the URL doesn't seem to want to update with the newCan you create relationships BETWEEN contacts within the same module
I am setting up my CRM, and I want to have a way to connect contacts within the same module. Is there a way to do this? If not - how do I decide how to split up contacts to make connections? What are best practices for this? We have clients who needFunction and workflow to create customer payment and send receipt
I am attempting to set up a workflow/custom function for the automatic creation of a customer payment and sending the email receipt, but am receiving the error "Improper Statement Error might be due to missing ';' at end of the line or incomplete expression" I've been over everything several times and cannot see where the error is (code is copied into the attached document). I haven't used custom functions before with Deluge, so it's very likely something very simple, or I've completely muckedDisable Sign Up option in Zoho Creator Portal and show only Sign In page
Is it possible to disable the Sign Up option in a Zoho Creator portal? The requirement is to show only the Sign In page and completely remove or hide the Sign Up page, so users cannot create accounts directly from the portal login page. Is there any settingRestrict Payment Methods
Allow us to restrict certain payment methods specific for each customer.How to install Widget in inventory module
Hi， I am trying to install a app into Sales Order Module related list, however there is no button allow me to do that. May I ask how to install widget to inventory module related list?Can I view the KB in the same way as a customer logged in as my Agent?
Sorry if this seems a mad question. I have some Articles that I want to be seen by my Agents and the status of these is set to Agents only. We also have some that are set to Public. When I sign in with my private email address (as a customer) I canWhat’s New in Zoho Inventory — Latest Features, Integrations & Updates | December 2025
Zoho Inventory has evolved significantly over the past months, bringing you smarter, faster, and more connected tools to streamline your operations. Whether you’re managing multichannel sales, complex fulfillment workflows, or fast-moving stock, our newestWhich user's capacity is used for Shared Mailbox storage?
We use shared mailboxes at our company, and their size is increasing daily. Which user(s)'s total mailbox limit is being used up by this space?Evernote (ENEX) import limitations
I have been with Evernote since 2010, but the latest price increase is ridiculous. I am currently testing Zoho Notebook as a replacement. I am impressed so far - if it were not for critical need to import legacy Evernote notes, I would 100% migrate toCan I create a CODE 128 custom field for my items in Zoho Inventory and then use it for generating Sales Orders?
Can anyone helps me, I don't want to use the SKU code for scanning my products. Because all my products have a CODE-128 label attached.Prevent duplicate with custom fields?
I was wondering something about custom field/custom modules in Zoho Desk. For some reason you can make a custom field mandatory but not unique? For example, if I create a custom module to manage equipment and renewal and make a field serial number noZoho Books' 2025 Wrapped
Before we turn the page to a new year, it’s time to revisit the updates that made financial management simpler and more intuitive. This annual roundup brings together the most impactful features and enhancements we delivered in 2025, offering a clearMultiple Vendor SKUs
One of the big concerns we have with ZOHO Inventory is lack of Vendor Skus like many other inventory software packages offer. Being able to have multiple vendor skus for the same product would be HUGE! It would populate the appropriate vendor Sku forCreate Invoice automated with Package
Does anyone knows how to create an invoice from a SO when we have created the package? We do these manually. and validate that the product packed is the product invoiced (if the order is partially packed) Regards, JSUnable to integrate Zoho Projects and Zoho Workdrive
I'm a Zoho One subscriber. When I go to Zoho Projects > Settings > Marketplace > Zoho Apps I do not see an option for Zoho Workdrive but I do see one for Zoho Docs that does nothing. How do I get the option to integrate Zoho WorkDrive and Zoho ProjeDisable payment thank-you emails
Hello, can someone please tell me how to disable sending of the "Payment Thank-You" emails?How to backdate record payment for the invoice
I would like to record a payment which happened 2 days ago, but I am not able to select any date later than today. I backdated the invoice, too, but it doesn't change anythingHelp with deluge script
Hi Community, this is my first Deluge script. I've pieced it together from reading various articles I want to use it in a workflow to 1 Convert a lead to a contact 2. Create a record in a custom module Below is what I have got so far but it does not fireMarketer's Space: Why email authentication matters in Zoho Campaigns
Welcome back to another post in Marketer's Space! If you've recently started using Zoho Campaigns, you've probably come across terms like SPF and DKIM. You may have also noticed emails that show "via zcsend.net" in Gmail when testing or sending campaigns.Feature Request: "Send Invitation" Toggle for Events
I am writing to request a critical "Quality of Life" update for the Activities module. Currently, adding people to the Participants field in an Event triggers an automatic email invitation/acceptance tracking with no way to opt-out. For general eventsEdit email address that appears on invoice
Hi How do I change the email address that appears on invoices, it is showing the email address that i used to sign up to zoho with but I want to change it to another email address that we use for accounts. also is there a way to edit the position of aIntroducing Zoho Sprints 3.0
Zoho Sprints is consistently evolving in steady increments. The introduction of the latest version, with its enterprise level solutions, brings to you advanced capabilities that propel your agile efforts in the right direction. Here's a quick glimpseNext Page