Kaizen #36 - Tasks #API
Hello everyone!
Welcome back to another post in the Kaizen series!
This week, we will discuss adding, updating, and deleting Tasks.
A task is a specific piece of work that is usually time-bound. In Zoho CRM, tasks are listed in the record's Home page, Activities' home page, and in other related records.
Let us now see how to work with Tasks using APIs.
1. Creating a Task
Use the Insert Records API to create a task.
Request URL: {{api-domain}}/crm/v2/Tasks
Request method: POST
Sample Input (se_module Leads)
{ "data": [ { "Subject": "Team_Meeting", "What_Id": { "name": "Christopher Maclead", "id": "3660682000000516249" }, "Status": "In Progress", "Due_Date": "2020-05-30", "Priority": "High", "$se_module": "Leads" } ] } |
Sample Input (se_module Contacts)
{ "data": [ { "Subject": "Team_Meeting"1, "Who_Id": { "name": "Kris Marrier , "id": "3660682000000516033" }, "Status": "In Progress", "Due_Date": "2020-05-30", "Priority": "High", "$se_module": "Contacts" } ] } |
Sample Input (se_module Accounts)
{ "data": [ { "Subject": "Meeting1", "Who_Id": { "name": "Kris Marrier", "id": "3660682000000516033" }, "What_Id": { "name": "Zylker", "id": "3652397000000624046" }, "Status": "In Progress", "Due_Date": "2020-05-02", "Priority": "High", "$se_module": "Accounts", "Remind_At": { "ALARM": "FREQ=WEEKLY;UNTIL=2020-05-21T11:00:00+05:30ACTION=POPUP;TRIGGER=DATE-TIME:2020-05-01T11:00:00+05:30" }, "Recurring_Activity": { "RRULE": "FREQ=WEEKLY;INTERVAL=1;UNTIL=2020-05-16;BYDAY=SA;DTSTART=2020-05-02" } } ] } |
Input JSON
Key | Data Type | Description |
Subject | String | Subject of the task. This key is mandatory. |
Who_Id | JSON Object | ID of the contact the task is related to. Applicable when module is contacts. |
What_Id | JSON Object | ID of the record for modules other than contacts. For Accounts module, this is the ID of the module the contact is associated with the contact whose ID is given in the Who_Id key. |
Status | String | The status of the task. The possible values are "Not Started", "Deferred", "In Progress", "Completed", and "Waiting on someone else". |
Due_Date | Date in yyyy-mm-dd format | The date on which the task is due. |
Priority | String | The priority of the task. The possible values are "High", "Highest", "Low", "Lowest", and "Normal". |
$se_module | String | The API name of the parent module that the contact is associated with. This key is mandatory when you include Who_id and What_Id. |
Remind_At
Key | Data Type | Description |
FREQ | String | Defines the frequency of the reminder. The possible values are DAILY, WEEKLY, MONTHLY, YEARLY, NONE. If you specify, NONE, the system sets a one-time reminder and TRIGGER becomes mandatory. |
Action | String | Represents how you want to remind the task owner about the task. The possible values are EMAIL, POPUP, EMAILANDPOPUP. |
TRIGGER=DATE-TIME | DateTime (ISO8601) | Defines when you want to trigger the reminder. This key is mandatory. Example: 2020-05-01T12:28:00+05:30. |
TRIGGER=TIME | hh:mm | 24-hour time format at which the system must trigger the reminder. Example: 23:45 |
Note
- Triggers can be given based on due date. For instance, if you want the reminder to be triggered one day before the due date:TRIGGER = -P1D.
- Similarly, if you want the reminder to be triggered two weeks before the due date:TRIGGER= -P2W. This applies only to recurring tasks, and the trigger time is mandatory.
Recurring_Activity
We have discussed this key in detail in Kaizen#8 - Handling Recurrence and Participants in the Events module via API.
Here is the response.
Since we have created a recurring task that recurs thrice, the system creates three individual tasks.
2. Updating a Task
The input keys are similar to the ones mentioned in the Insert a Task section.
In this example, we are updating the reminder (the "remind_at" key) of one of the recurring tasks.
Request URL: {{api-domain}}/crm/v2/Tasks/3652397000002133013
Request method: PUT
Sample Input
{ "data": [ { "Subject": "Meeting1", "Remind_At": { "ALARM": "FREQ=NONE;ACTION=POPUP;TRIGGER=-P1D;TRIGGER_TIME=11:00" } } ] } |
Sample response
Errors common to inserting and updating a task
Error code | Reason | Handling |
INVALID_DATA | The ID you specified in what_id or who_id is invalid. | Specify the correct ID. |
MANDATORY_NOT_FOUND | You have not specified TRIGGER in "Remind_At" or UNTIL and DTSTART in RRULE keys. | Specify the mandatory keys. |
INVALID_RRULE | You have specified an incorrect value for FREQ, INTERVAL, or BYMONTHDAY, BYDAY, BYMONTH, BYSETPOS. | Specify the correct value for RRULE. |
3. Deleting a Task
Use the Delete Specific Record API or Delete Records API to delete the task(s).
Request URL: {{api-domain}}/crm/v2/Tasks/3652397000002133013 or
{{api-domain}}/crm/v2/Tasks?ids=3652397000002133013,3652397000002133010
{{api-domain}}/crm/v2/Tasks?ids=3652397000002133013,3652397000002133010
Request method: DELETE
Sample response
We hope you found this post useful.
Write to us at support@zohocrm.com if you have any questions, or let us know in the comment section.
Cheers!
Access your files securely from anywhere
Centralize Knowledge. Transform Learning.
All-in-one knowledge management and training platform for your employees and customers.
New to Zoho Recruit?
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Bigin?
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
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho CRM Resources
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
UK payroll entries
Hey guys, Nett payroll payments are imported direct into the bank, using an external payroll system (will be glad for Zoho to have a UK payroll app) At present I have monthly recurring bills for HMRC which are auto entered & paid when due. This seemsZoho Commerce + MCP + Claude
Hi everyone, I wanted to share a really impressive experience I had with Zoho Commerce + MCP + Claude. I created an MCP server using Zoho MCP Server and connected my Claude instance to my store built with Zoho Commerce. For safety, I enabled only productauto add as member the contact owner
is there a way that i can make a zoho flow that will add the owner of the contact as a member of the chat after the round robin assignment?Get Files Associated to Data Template via API
I have a data template with multiple files associated to it, and trying to write a Deluge script that will fetch files associated with this data template. I created the script below based on the WorkDrive API documentation, one request uses the data templatesZoho Book - Banking Module - Cash Credit account
I have a CC account with a bank. I initially added the account as a 'Bank Account' under the banking module in Zoho Books. However, this CC Bank Account is showing as an asset instead of a liability. I have added the account as a credit card account butAdding a custom formula field from sub-forms
I have used my 5 Aggregated Sum fields in the subform. I have another column I want to add a summary of. This can be in a separate section/field. The formula field won't pull in information from the sub-form. How do I pull information from the sub-formRemove Zoho Header from Portals
I have a portal page with custom domain. But when I print directly from a webpage, the Zoho CRM header shows. It kind of kills the branding aspect. Is there a way to get rid of this?Creator List not showing
I've edited a list in creator, but when I open it in the live version the list is completely different. Anyone know why this is happening? Edit Version: Live Version:Please design a better spam filter
Hi Team, While I love Zoho Mail for all the awesome features you have designed - this is the one you need to do a lot of work on - Spam Filter. Your spam categorization seems to be very inefficient - any email containing brand images or a tracking pixelHost not reachable when sending
For few partner that I send regular emails now got error and they don't receive emails Temporary failure fam-xxx.hr/185.xx.xx.xxx Host not reachable. Have more than 20 mails in https://mailadmin.zoho.eu/cpanel/home.do#mailSettings/retryEmail pleaseIP flagged as abusive
I'm getting the error that 136.143.188.15 is listed as abusive. I've checked with mxtoolbox.com and it is indeed in the listApp passwords stop working
Some of my app passwords appear to stop working after awhile. Seems to happen every 6 months or so. Just had to change one again for the second time in a year. Is this a bug or a feature? Or perhaps changes are being made on the back end on occasion thatDuplicate entries for contacts birthdays
Good morning I have recently started to use my Zoho calendar and noticed that there are multiple birthday events showing for some of my contacts. I have checked my contacts and there were duplicates for some contacts which I have now rectified but theProblem: New Email Consistently Failing to Sync/Display in Inbox
Recently, I have noticed that my Zoho Email inbox does not indicate I've received a new email, until I go to *another* folder and then return to the inbox. Only then will new emails be displayed. This has happened 100% of the time, during the past fewZoho IMAP Access to mail doesn't sync messages
As stated in the topic - I have company account email address setup, and it has ( as in the picutre ) ActiveSync and Imap access enabled. However the messages does not show up while logged in in Zoho Mail however when I log in in thunderbird everythingCliq iOS can't see shared screen
Hello, I had this morning a video call with a colleague. She is using Cliq Desktop MacOS and wanted to share her screen with me. I'm on iPad. I noticed, while she shared her screen, I could only see her video, but not the shared screen... Does Cliq iOS is able to display shared screen, or is it somewhere else to be found ? RegardsTemps working custom view in Zoho Recruit
How do you create a custom view of temps working for this week. I have tried multiple combinations of job status, start date, end date etc but I am unable to find the correct combinations to show the temps I have working this week?? Any suggestions on how I can do this.Client Scripts similar to CRM?
Hi, Is there any plans for Client Scripts to become a feature of Recruit? Feel this will be a great benefit to a number of users. Would be great for example in cases where a Client has banned / blacklisted a Candidate - so that if that candidate is associatedAnnouncing Zoho Sheet desktop app for macOS and Windows (Beta)
Hello Sheet users, We know you’ve been waiting for this one. It has always been the top priority on our roadmap to provide a single native desktop app for macOS and Windows that works both online and offline. Today, we are excited to announce that theAutomated entries past the current month in a calendar report
Hi all, I have an automation problem. I have a form which on successfull entry adds either 5 or 10 more of these entries with a slight change so our customers can see it throug a calendar report on the webiste. The entry put in manually shows up perfectlyBilling Status Update
Hello Latha, I’m working on a new automation (deluge) to fulfill one of our requirements. In this automation, there is a step to update the Work Order billing status from “Not Yet Invoiced” to “Non-Billable.” I tried to find the API information relevantWhat's New in Zoho POS - April 2026
Hello everyone, Welcome to Zoho POS’s monthly update, where we share our latest feature updates, enhancements, events, and more. Let’s take a look at how April went. Access and manage other web applications in Zoho POS with Web Tabs You can now accessMany Zoho POS Issues
Can not apply credits from a customers account as a form of payment. It shows that you can but there is a bug that does not execute the action. Reported many times. Can not view Sessions from Zoho POS WebView, throws a JQUERY error Workflows and actionsHOW I CAN GET BETA VERSION FOT TESTING
HI. ZOHO I AM INTERESTED IN YOUR BETA SOFTWARE TO EXPERIENCE NEW FEATURES.Multiple EAN code for product
option to add multiple EAN code for product???Issue adding/changing mobile number for OTP
Hi Zoho Community, I’m trying to add or change my mobile number, but I keep getting this error: “We’re unable to send OTP to this mobile number. Please contact support-as@eu.zohocorp.com” Because of this, I can’t verify my number or continue the setup.Zoho Payroll Canada does not work
We submitted payroll within the required timelines. The money was withdrawn from our account and our employees have not been paid. Impossible to get a hold of someone at Zoho. I can’t believe the company operates like this. What a bloody disgrace. ShameEnhance Appointment Buffers in Zoho Bookings
There was previously a long-standing feature request related to enhancing the way appointment buffers work in Zoho Bookings, but it looks like the original post has been deleted. I am therefore adding a new request that Zoho Bookings adjust how appointmentFunctionality based URL to find records due today or in the next week
I need to construct a URL to filter a view to records where the evaluation is due soon (i.e. in the next 7 days). To me, that includes today, but Zoho has a different opinion. Zoho defines 39 as NEXT_7_DAYS but this gives unexpected results. https://creatorapp.zoho.eu/...#Report:My_Evaluations?Evaluation_due_by_op=39Allow customers to choose meeting venue and meeting duration on booking page
My business primarily involves one-to-one meetings with my clients. Given the hybrid-work world we now find ourselves in, these meetings can take several forms (which I think of as the meeting "venue"): In-person Zoom Phone call I currently handle theseEvent Time Zone in meeting invites are confusing users
When sending calendar invites to internal and external users, the first section "Event Time Zone" is confusing people and they are automatically declining events. Can this section please be removed??? It already shows the correct time zone next to theForwarding without verification
Hi, I use Tripit to keep track of all my business travel. I've recently moved over to Zoho and wanted to set up a forwarding rule to send various travel confirmation emails automatically to plans@tripit.com Obviously this is an email address I don't control,Filter by user in Pivot Chart
I have a Pivot chart where the data should be filtered by user. The user enters the system and should see only the data that correspond to it. Can anyone help me?All new Address Field in Zoho CRM: maintain structured and accurate address inputs
Availability Update: 29 September 2025: It's currently available for all new sign-ups and for existing Zoho CRM orgs which are in the Professional edition exclusively for IN DC users. 2 March 2026: Available to users in all DCs except US and EU DC. 24Whatsapp Limitation Questions
Good day, I would like to find out about the functionality or possibility of all the below points within the Zoho/WhatsApp integration. Will WhatsApp buttons ever be possible in the future? Will WhatsApp Re-directs to different users be possible basedInternal mails on our company domain (managed by Zoho) do not get delivered
Hi last week Thursday and Friday a colleague had sent me two emails which did not show up at all in my inbox, spam or anywhere else. What this a problem with Zoho mail in general or did this affect just us? From the forum is reads like many problems had#2 The Tax Talk Nobody Wants to Have
"We are also able to manage our GST invoices without worrying about compliance issues. With Zoho Invoice, we are happy, our tax consultant is happy, and so are our customers," rejoices Shivprateek Habib, Partner, Flutterboots Services LLP. That's usuallyBulk upload images and specifications to products
Hi, Many users have asked this over the years and I am also asking the same. Is there any way in which we can bulk upload product (variant) images and product specifications. The current way to upload/select image for every variant is too cumbersome.Workflows fail silently in Zoho CRM and there is no native way to know
Workflow automation is honestly one of the biggest reasons my clients choose Zoho. But there is one problem I keep running into across almost every implementation. When a workflow fails, nobody finds out. Email alerts hit daily limits and just stop. CustomZoho Commerce and Third-party shipping (MachShip) API integration
We are implementing a third-party shipping (MachShip) API integration for our Zoho Commerce store and have made significant progress. However, we need guidance on a specific technical challenge. Current Challenge: We need to get the customer input toNext Page