Kaizen #36 - Tasks #API

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

Here is the response.
Since we have created a recurring task that recurs thrice, the system creates three individual tasks.



2. Updating a Task
Use the Update Specific Record API or Update Records API to update the task(s).
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
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

        All-in-one knowledge management and training platform for your employees and customers.






                              Zoho Developer Community




                                                    • Desk Community Learning Series


                                                    • Digest


                                                    • Functions


                                                    • Meetups


                                                    • Kbase


                                                    • Resources


                                                    • Glossary


                                                    • Desk Marketplace


                                                    • MVP Corner


                                                    • Word of the Day


                                                    • Ask the Experts



                                                              • 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 this
                                                              • Kaizen #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 how
                                                              • 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 are


                                                              Manage your brands on social media



                                                                    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

                                                                                        • CRM Community Learning Series

                                                                                          CRM Community Learning Series


                                                                                        • Kaizen

                                                                                          Kaizen

                                                                                        • Functions

                                                                                          Functions

                                                                                        • Meetups

                                                                                          Meetups

                                                                                        • Kbase

                                                                                          Kbase

                                                                                        • Resources

                                                                                          Resources

                                                                                        • Digest

                                                                                          Digest

                                                                                        • CRM Marketplace

                                                                                          CRM Marketplace

                                                                                        • MVP Corner

                                                                                          MVP Corner







                                                                                            Design. Discuss. Deliver.

                                                                                            Create visually engaging stories with Zoho Show.

                                                                                            Get Started Now


                                                                                              Zoho Show Resources

                                                                                                Zoho Writer

                                                                                                Get Started. Write Away!

                                                                                                Writer is a powerful online word processor, designed for collaborative work.

                                                                                                  Zoho CRM コンテンツ




                                                                                                    Nederlandse Hulpbronnen


                                                                                                        ご検討中の方




                                                                                                                • Recent Topics

                                                                                                                • Cliq Bots - Post message to a bot using the command line!

                                                                                                                  If you had read our post on how to post a message to a channel in a simple one-line command, then this sure is a piece of cake for you guys! For those of you, who are reading this for the first time, don't worry! Just read on. This post is all about how
                                                                                                                • 【Zoho CRM】営業日のロジックに関するアップデート

                                                                                                                  ユーザーの皆さま、こんにちは。コミュニティチームの中野です。 今回は「Zoho CRM アップデート情報」の中から、営業日のロジックに関するアップデートをご紹介します。 本アップデートにより、ワークフローにおける営業日の計算方法が改善されました。 週末などの非営業日にワークフローのトリガーが発生した場合でも、 「+0」「+1」「+2 営業日」といった設定が、意図どおりに正確に動作するようになりました。 営業日に基づくワークフローでは、日付項目を基準に「何営業日後に処理を実行するか」を指定します。
                                                                                                                • Merged cells are unmerging automatically

                                                                                                                  Hello, I have been using Zoho sheets from last 1 year. But from last week facing a issue in merged cells. While editing all merged cells in a sheet became unmerged. I merged it again, but it again unmerged. In my half an hour work I have to do this 3-4
                                                                                                                • Introducing Built-in Telephony in Zoho Recruit

                                                                                                                  We’re excited to introduce Built-in Telephony in Zoho Recruit, designed to make recruiter–candidate communication faster, simpler, and fully traceable. These capabilities help you reduce app switching, handle inbound calls efficiently, and keep every
                                                                                                                • Just want email and office for personal use

                                                                                                                  I am unclear as how to how I would have just a personal email (already do have it and love it) and get to use docs, notebook, workdrive etc. In other words mostly everything I had a google. I find gocs can be free with 5gb and so can mail with 5gb. Are
                                                                                                                • Unable to change the "credentials of login user" option when creating a connection

                                                                                                                  I want to create a new Desk connection where the parameter to use 'credentials of login user' is set to YES. I'm able to create a new connection but am never given the option to change this parameter. Is this a restriction of my user profile, and if so,
                                                                                                                • Show backordered items on packing slip

                                                                                                                  Is it possible to show a column on the Packing Slip that shows number of backordered items when a PO is only partially filled? I would also like to see the Backordered column appear on POs after you receive items if you didn't get ALL of the items or partial amounts of items. And lastly, it would be nice to have the option of turning on the Backordered column for invoices if you only invoice for a partial order. -Tom
                                                                                                                • Zoho CRM Community Digest - January 2026 | Part 1

                                                                                                                  The new year is already in motion, and the Zoho CRM Community has been buzzing with steady updates and thoughtful conversations. In this edition, we’ve pulled together the key product enhancements, Kaizen learnings, and helpful discussions from the first
                                                                                                                • Zoho CRM Feature Requests - SMS and Emails to Custom Modules & Time Zone Form Field

                                                                                                                  TLDR: Add Date/Time/Timezone form field, and be able to turn off auto timezone feature. Allow for Zoho Voices CRM SMS Extension to be able to be added to custom modules, and cases. Create a feature that tracks emails by tracking the email chain, rather
                                                                                                                • Introducing Bigin's Add-in for Microsoft Outlook

                                                                                                                  Hello Everyone, Email is an important way to communicate with customers and prospects. If you use Outlook.com for emails and Bigin as your CRM, the Outlook Add-in helps you connect them easily so you can see your Bigin contact details right inside Outlook.com.
                                                                                                                • Ask the Expert – Zoho One Admin Track : une session dédiée aux administrateurs Zoho One

                                                                                                                  Vous administrez Zoho One et vous vous posez des questions sur la configuration, la gestion des utilisateurs, la sécurité ou encore l’optimisation de votre back-office ? Bonne nouvelle : une session Ask the Expert – Zoho One Admin Track arrive bientôt,
                                                                                                                • Zoho Commerce

                                                                                                                  Hi, I have zoho one and use Zoho Books. I am very interested in Zoho Commerce , especially with how all is integrated but have a question. I do not want my store to show prices for customers that are not log in. Is there a way to hide the prices if not
                                                                                                                • How to Associate Zoho Projects in Zoho CRM

                                                                                                                  Hi I need script for associating projects in zoho projects to particular Account in zoho CRM side. It can be done manually but I need the automation for this process. There are no api regarding associating a project in zoho crm account. Need assistance
                                                                                                                • Add Claude in Zoho Cliq

                                                                                                                  Let’s add a real AI assistant powered by Claude to your workspace this week, that your team can chat with, ask questions, and act on conversations to run AI actions on. This guide walks you through exactly how to do it, step by step, with all the code
                                                                                                                • Need to set workflow or journey wait time (time delay) in minutes, not hours

                                                                                                                  Minimum wait time for both Campaigns workflows and Marketing Automation journeys is one hour. I need one or the other to be set to several minutes (fraction of the hour). I tried to solve this by entering a fraction but the wait time data type is an integer
                                                                                                                • Editing Item Group to add Image

                                                                                                                  I did not have the image of the product when the Item Group was created. Now I have the product image, and would like to associate/add to the Item Group. However the Item Group Edit functionality does not show/allow adding/changing image. Please hel
                                                                                                                • Zoho Books - France

                                                                                                                  L’équipe de Zoho France reçoit régulièrement des questions sur la conformité de ses applications de finances (Zoho Books/ Zoho Invoice) pour le marché français. Voici quelques points pour clarifier la question : Zoho Books est un logiciel de comptabilité
                                                                                                                • New in Office Integrator: Download documents as password-protected PDFs

                                                                                                                  Hi users, We're excited to introduce password-protected PDF as a download option in Zoho Office Integrator's document editor. This allows you to securely share confidential information from within your web app. Highlights of the password-protected PDF
                                                                                                                • Sales IQ - Zobot en multilangue

                                                                                                                  Bonjour, J'ai un Zobot installé sur mon site depuis longtemps. J'ai ajouté plusieurs langues, dans la configuration et dans le générateur de bot sans code Pourtant, le Chat continue à s'afficher en Francais. Comment enclencher le multilangue en front
                                                                                                                • Streamlining E-commerce Photography with AI Background Tools

                                                                                                                  Hey Zoho Community, I’ve been messing around with ways to make product images less of a headache for fashion brands on Zoho Commerce. You know how boring generic backdrops can get, and how much time traditional photoshoots eat up, right? I tried out this
                                                                                                                • Unable to Assign Multiple Categories to a Single Product in Zoho Commerce

                                                                                                                  Hello Zoho Commerce Support Team, I am facing an issue while assigning categories to products in Zoho Commerce. I want to assign multiple categories to a single product, but in the Item edit page, the Category field allows selecting only one category
                                                                                                                • Collapsing and expanding of lists and paragraphs

                                                                                                                  hello Would you ever implement Collapsing and expanding of lists and paragraphs in zoho writer ? Best regards
                                                                                                                • Saving issue

                                                                                                                  First problem I opened a MS word file in writer. after the work is done, it does not save instantly, I waited for like 10min and it still did not save. second problem When I save a file, then file gets saved as another copy. I just did save, not save
                                                                                                                • Serious problem with file that contains non-ASCII characters

                                                                                                                  I imported many pdf files from Evernote whose names contain Hebrew characters, such as ח רבעוני - ביטוח חיים - סוף רבעון 3 - לשנת 2025.pdf I have two very serious problems: (1) Zoho Notebook cannot open the pdf file; (2) It cannot download the pdf file.
                                                                                                                • Notifications Feeds unread count?

                                                                                                                  How do I reset the unread count on feeds notifications?  I've opened every notification in the list.  And the count never goes to zero.
                                                                                                                • Zoho Finance Limitations 2.0 #3: Can't assign a Contact to a Finance Record (estimate, sales order or invoice)

                                                                                                                  If you use a business to business scenario with different contact people within the company you can't assign a finance record (estimate, invoice, etc...) to that person. Why this matters? No way to find out which person placed the order without manual
                                                                                                                • Zoho Community Digest — Febrero 2026

                                                                                                                  ¡Hola, comunidad! Un mes más os traemos las novedades más interesantes de Zoho para febrero de 2026, incluyendo actualizaciones de producto publicadas oficialmente, cambios de políticas y noticias del ecosistema. Pero antes de lanzarnos a las actualizaciones,
                                                                                                                • Disable Zoho Contacts

                                                                                                                  We don't want to use this app... How can we disable it?
                                                                                                                • Filter button in the Zoho Sheet Android App doesn't toggle on

                                                                                                                  I am a new Zoho Sheets user and experiencing a specific issue with the filter functionality in the Android mobile application. Detailed Issue Description: The filter icon appears correctly in the toolbar. Upon tapping the filter icon/button, the toggle
                                                                                                                • 【Zoho CRM】商談タブへのデータインポート

                                                                                                                  Zoho使用前にエクセルで管理していた商談情報を、Zoho一括管理のため、商談タブにインポートしたいのですが、お客さまの氏名だけが紐づけられませんでした。 「Zoho CRMにインポートする項目を関連付ける」のところが画像のようになっています。 (弊社では、「姓」を「★個人データ名」という項目名に変更し、フルネームを入れて使用しています。) どのようにしたら氏名をインポートできるかご存じの方がいらっしゃいましたら、ご教示いただきたく、よろしくお願いいたします。 (投稿先が間違っていましたらご指
                                                                                                                • CRM Cadences recognise auto-responses

                                                                                                                  I have leads in a Cadence. I get an auto-responder reply "I'm out of the office..." Normally Cadences seems to know that isn't a real reply and keeps the lead enrolled in the cadence. However, today, Cadences has UNENROLLED a Lead who sent an auto-reponse
                                                                                                                • SalesIQ Chat Notifications

                                                                                                                  I am the admin of our salesIQ implementation. About two weeks ago, I started hearing/seeing notification for ALL chats messages from monitored agents/chat participants. I don't need to see these, we have a manager who deals with this. I can't stop the
                                                                                                                • How to Create a Fixed Sliding Time Window (D-45 to D-15) in Zoho Analytics ?

                                                                                                                  Hello, I would like to create a report in Zoho Analytics based on a sliding time window between D-45 and D-15, with a fixed snapshot of that specific period. The data displayed should strictly reflect activity recorded between D-45 and D-15 only, without
                                                                                                                • Export Zoho Books to another accounting package?

                                                                                                                  Is an export feature to Quickbooks or Accpac available (or a form that is easily imported by them)?  My reasons: 1) my accountant, who prepares my corporate tax return, prefers to work with their own accounting system.  If I can convert Zoho books a form that is easily importable into Quickbooks or an Accpac format, this process would be easy. 2) I don't want to keep my data in a proprietary format on the cloud somewhere without a way to easily extract it to a format that can be read my a well established
                                                                                                                • Anchor Links in Dashboards

                                                                                                                  Hello,  Our dashboards frequently have multiple sections that would be more easily skipped between using anchor links. Please consider adding an anchor link feature to the text widget? This could be done by adding an anchor link option to the text widget next to the "remove" option (see screenshot). The option would assign an ID to the <div> containing the text widget in the live dashboard. Then, the chosen ID could be linked using a traditional <a href="#link_id"> in the html section of the text
                                                                                                                • Introducing Auto-trigger for Screening Bot

                                                                                                                  Still manually sending screening tests after every application? Not anymore. With Auto-trigger for Screening Bot, screening now begins automatically. When a candidate applies for a job that has an attached assessment, Recruit checks whether the test has
                                                                                                                • Importing into Multiselect Picklist

                                                                                                                  Hi, We just completed a trade show and one of the bits of information we collect is tool style. The application supplied by the show set this up as individual questions. For example, if the customer used Thick Turret and Trumpf style but not Thin Turret,
                                                                                                                • Add line item numbers to sales order/invoice creation page

                                                                                                                  It would be really helpful if there were line numbers visible as we are creating a sales order and/or invoice. There are line numbers visible in the PDF once the sales order is created. I would like to be able to see the line numbers as I am building
                                                                                                                • API to Apply Retainer invoice payment to Invoice

                                                                                                                  Hi Team, I could not find  API to apply the Retainer invoice payment to existing Invoice. Can you please help ? Attaching the screenshot
                                                                                                                • Reconciling a month with no transactions

                                                                                                                  I'm treasurer for a small non profit cemetery association and I'm trying to reconcile a bank statement for a month that did not have any transactions. Do I skip the month entirely and go a month with transactions?
                                                                                                                • Next Page