Kaizen 259 - Working with Zoho CRM APIs using the zoho-crm skill

In the previous Kaizen, we introduced the zoho-crm skill and discussed how it can work with different CRM developer capabilities.

The zoho-crm skill makes it easier to work with Zoho CRM without having to remember every API endpoint, request structure, or the documentation needed for a particular requirement. You can describe what you want to build, and the skill determines the appropriate CRM capability and uses the relevant references to come up with the solution.

As of now, the skill supports REST APIs, Deluge Functions, Client Scripts, Widgets, COQL, Queries, and Connections, with more capabilities to be added over time.

In this Kaizen, we will look at how the skill can help you when you are working with Zoho CRM APIs.

For the demo, I have already installed the zoho-crm skill in my project and will be using GitHub Copilot. We will use a Lead management requirement and see how the skill helps us identify the required APIs and construct the requests.

We will start with individual actions and then combine them into a workflow.

Working with Zoho CRM APIs using zoho-crm skill  

To see how the zoho-crm skill helps with API usage, let us take a Lead management requirement.

Assume that whenever a Lead is qualified, we want to perform the following actions:

• Set the Lead's Priority to Hot

• Create a follow-up task for the Lead, due one day after the workflow is triggered

• Send the Lead details to an external system using a webhook

Instead of looking for the appropriate API, going through the documentation, and figuring out the request structure for each of these requirements, we can provide the requirement to an AI coding agent with the zoho-crm skill.

The skill identifies the relevant CRM API, loads the required API references, and generates the request based on the requirement.

For this demonstration, we will use GitHub Copilot as the AI coding agent.

Creating a Field Update Action  

We will start by creating a Workflow Field Update action for the Leads module. The requirement is to set the Lead's Priority field to Hot when the action is executed. We can provide this requirement to the AI coding agent with the zoho-crm skill.

Prompt: /zoho-crm Create an automation field update action for Leads module that sets the Priority field to "Hot". Give me the curl request.

The zoho-crm skill first identifies that this requirement should be handled using the Workflow Field Update API. It then checks the relevant API reference to understand the endpoint, request structure, required parameters, and OAuth scope.

The generated request contains the organization-specific field information required for the Field Update action. Where an ID is required, the skill identifies that the value needs to be obtained from CRM metadata rather than asking us to manually figure out where it comes from. It also identifies the API that can be used to retrieve the required field details. We can use that API to get the field ID, replace the placeholder in the generated cURL request, and execute the request. The skill also identifies the OAuth scope required for the request, so you know exactly what permissions to configure before making the call.

The generated cURL request can then be executed to create the Field Update action in Zoho CRM. The response gives us the action ID, which we will use later when creating the workflow.

Creating a Task Action  

Next, we will create the Task action that needs to be associated with the workflow.

The requirement is to create a follow-up task titled "follow up with qualified lead", with the due date set to one day after the workflow is triggered.

Prompt: /zoho-crm Create a Zoho CRm workflow task action for the Leads module that creates a follow-up task titled "follow up with qualified lead" with the due date set to 1 day after the workflow is triggered. Give me the cURL request.

The skill identifies this as a Workflow Task requirement and loads the relevant Task Action API reference. It checks the API structure and the mandatory fields required for creating the task action, such as the task subject, due date, status, and priority.

For the due date, the skill also needs to represent the requirement relative to the workflow execution time. It constructs the request using the workflow execution time as the starting point and adds one day to it. The skill also identifies the organization-specific field IDs required for the Task action. If these IDs are not already available, it points to the CRM Fields Metadata API that can be used to retrieve the field details for the Tasks module.

Based on these references, the skill generates the cURL request for creating the Task action. The generated cURL request can then be executed to create the Task action in Zoho CRM. The response gives us the action ID, which we will use later when creating the workflow.

Creating a Webhook Action  

The third action is a webhook that sends the Lead details to an external system.

Prompt: /zoho-crm Create an automation webhook action for the Leads module that sends the Lead ID, Lead Name, Email and Phone to this endpoint : https://webhook.site/b89a8c65-8623-4af4-b579-8fa1853ad615. Give me the cURL request.

Here, the skill identifies that this is a Workflow Webhook action and refers to the corresponding Webhook API documentation. It also takes care of an important part of the request; mapping CRM fields to the data that needs to be sent to the external endpoint.

The generated request uses Zoho CRM merge fields to populate the webhook payload when the workflow executes. In our case, the payload contains the Lead ID, Lead Name, Email, and Phone. The skill also checks the API requirements, including the required OAuth scope and the structure of the webhook request, before generating the cURL.

We can then execute the generated cURL request to create the webhook action in Zoho CRM. The response gives us the action ID, which we will need when we define the workflow.

At this point, we have the three actions required for our use case:

• A Field Update to set Priority to Hot

• A Task to follow up with the qualified Lead

• A Webhook to send the Lead details to an external system

The next step is to bring these three actions together and create the workflow rule that will execute them when a Lead is qualified.

Creating the Workflow Rule  

We now have all three actions ready. The final step is to create a workflow rule that brings them together.

For our use case, the workflow should run when the Lead Status is changed to Qualified. Once the workflow is triggered, it should execute the Field Update, Task, and Webhook actions we created earlier. Instead of manually working out the workflow API request structure, we can give the requirement to the skill along with the action IDs.

Prompt: /zoho-crm Give me the request body JSON to create a workflow rule named "Qualified Lead Follow Up" in the Leads module. Trigger when Lead_Status is changed to "Qualified".

Configure these as instant actions:
- Field Update: 4876876000025812036
- Task: 4876876000025831002
- Webhook: 4876876000025864002

The skill identifies this as a Workflow Rule API request. It determines how the field-update trigger needs to be represented and how the existing action IDs should be associated with the workflow as instant actions. It also uses the relevant workflow API reference to construct the request body, including the module, trigger criteria, and actions.

The skill generates the request body JSON, which we can use in the Workflow Rules API request.

So, the complete flow is now in place:

This is where the value of using the skill becomes more apparent. We started with a business requirement and, rather than having to determine the individual APIs and construct each request manually, the skill helped us identify the appropriate APIs, refer to the relevant documentation, and build the requests needed to put the complete workflow together.

Using the skill for other CRM requirements  

The zoho-crm skill can also act as a knowledgeable guide when working with CRM APIs. Instead of using it only to generate a request, you can use it to understand how a particular API works, determine which API is appropriate for a requirement, and get guidance on the request and response structure.

In other words, you can treat the skill as a Zoho CRM expert that you can consult while building your solution.

For example, consider the following requirement:

Prompt: /zoho-crm Retrieve Leads whose Lead Status is `Qualified` and whose Score is greater than `25`, and include details from the Account associated with each Lead (such as Account Name and Account Industry).

The skill identifies COQL as the appropriate API for this requirement. It checks the relevant references and API specification to determine the endpoint, required scopes, request structure, field names, and response format. It can also explain how COQL compares with other record retrieval APIs such as Get Records and Search Records, and why it is better suited to this particular requirement.

If you have doubts about a Zoho CRM API, the skill can help you understand the API, work through its request and response structure, and determine how it applies to your requirement.

In the upcoming weeks, we will explore more capabilities of the zoho-crm skill and see how it can help with the other developer tools available in Zoho CRM.

If you have questions about the skill, APIs, or any of the capabilities covered in this series, feel free to drop a comment below or reach out to us at support@zohocrm.com. We would also love to hear about the use cases you are exploring with the zoho-crm skill.

Previous Kaizen : Getting Started with zoho-crm SKILL.md | Kaizen Directory : Home

• Topic Participants

• Anu Abraham

  

• Sticky Posts

• Announcing the new SKILL.md for Zoho CRM and the updated OAS repository!

  We are introducing a new zoho-crm skill to make working with Zoho CRM Developer tools (like APIs, functions, widgets, client scripts, queries etc) easier and faster, with the help of AI in your preferred AI harness like Claude Code, Codex, Cursor, VSCode

• Kaizen #261 : Using Zoho CRM Skill to generate complex COQL queries

  Hello everyone, In the previous Kaizen posts, we introduced the zoho-crm SKILL.md and discussed how it can help you when you are working with Zoho CRM APIs and Client Script. In this Kaizen, we will focus on using the Zoho CRM `SKILL.md` with GitHub Copilot

• Kaizen #256 - Build an Arrival Readiness Web Tab in Zoho CRM

  Hi everyone! Welcome back to the Kaizen series! In the post, we discuss a use case in hospitality industry: how an Arrival Readiness web tab widget can be used to let reception staff identify and resolve issues before arrival of guests. Use case In the

• 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

• Recent Topics

• Undo/redo when composing Mail

  Where is the undo/redo button when composing mail? I've new to Zoho, I've looked, I've searched and can't find it. What am I missing?

• Mail menu bar items missing in Inbox and folders

  Last night some shortcuts such as Move to Folder, Archive, Delete, Mark as spam, and others, disappeared from my Mail menu bar, along with items in the vertical three dots extension such as Mark as read, Flag as, Mark as unread, etc. What I now have instead

• ERROR CODE :554 - Your access to this mail system has been rejected due to poor reputation of a domain used in message transfer

  This message was created automatically by mail delivery software. A message that you sent could not be delivered to one or more of its recipients. This is a permanent error. *****, ERROR CODE :554 - Your access to this mail system has been rejected due

• Sent items with shared folders

  Hello, this is in some way in between a problem and an idea.  When sharing folders (which is actually not any close to a shared mailbox...) the person which the folder has been shared with can access that folder and can send emails when delegation is

• Losing description after merging tickets

  Hello, We merge tickets when they are about the same topic from the same client. It happens sometimes. We recently noticed that after the merger only the description from the master ticket is left in a thread. And the slave-ticket description is erased.

• What's New in Zoho Inventory | July & August 2026

  Hello users, The July and August 2026 releases bring a range of new features and improvements across the product. From the Nigeria Edition and Super Admin enhancements to Sri Lanka IRD-compliant invoicing, Loyalty Program Management, and improvements

• E-mail com problema

  Não estou recebendo e-mail desde Janeiro. Algo desconfigurou e eu não consigo resolver. Podem ajudar? Aguardo. Wagner Della Aversana Whats 55 11 985119899

• Account Blocked due to Suspicious Activity.

  Hello, Trying to get access to my account, I have found this message above in the subject of this message. I am unable to log back to my account (see err. mess. below.) and thus cannot get rif of this following the Zoho procedure : I followed the step

• Widget Height were destroyed

  All widget heights in the Details Canvas view are broken. Moderation Update: This issue with widget heights in Client Script popups and flyouts has been resolved. Widgets should now display at their expected heights.

• SAML authentication in Zoho Mail: Simplify and secure your organization's login management

  Managing login credentials across multiple web applications can be challenging for organizations with a large number of users. Without a centralized authentication system, users are required to maintain separate passwords for each application, increasing

• How to prepare a balance sheet for a company that has no operations yet?

  .

• Can't create new account in zoho email

  Hello, i'm trying to create some free accounts to my customers... and since yesterday i can't create a new account, what is wrong? why i can't create free account? Thank You

• Name autocomplete

  Hi, During searching emails the web tool does not always propose the auto-completion of the saved emails. As a result I either have to go to contacts and look up the exact email, or the exact full name including the middle name and any dots, which is

• Merge Tickets Directly from Contact Page in Zoho Desk

  Dear Zoho Desk Support Team, We are writing to request a new feature that would allow users to easily merge tickets directly from the contact page in Zoho Desk. Currently, the only option to merge tickets is from the Tickets list view page, which can

• Introducing Incentives for Zoho CRM: Build, automate, and track sales commissions

  Dear Customers, We are here with an amazing news! We built a direct solution to help manage your commission provisioning activity in your business. From creating commission plans to issuing payouts, this application leverages your sales reps’ performance

• Specific ListView Canvas on Canvas Home Page Always Loads Most Recent ListView, Not the One Specified

  I had mentioned this to ZOHO, but I mainly wanted to see if others in the Community are also facing this problem. I created a Canvas ListView for a Custom Module, and then created a Canvas Home page (technically on a tab item, but I'm not sure if that

• Reminder Settings - Time Tracker

  On the time tracker in Reminder Settings I created a reminder according to the Zoho manual. But a manager asked me to change the message that goes in the email. Is it possible to change the message? I didn't find that in the Zoho manual. Another question: I configured to receive the reminder everyone who logged in less than 40 hours. Does Zoho consider less than 40 hours of the current week or the whole month? Another situation, I put it so that I and another specific user would receive the notification,

• Create a single record from multiple images with ICR

  Hello all, Zia's Intelligent Character Recognition can now create a single record from multiple images based on the configured ICR rule. Users can upload up to three images at once, such as an ID, a passport, and a business card, and Zia will extract

• SPF failure in android app

  I have no domain. I am not admin of anything. All I want to do is send an email from a zohomail.eu address, using the Zoho android app, with all settings as default. I do not use Office 365, or EOP, or Outlook, and I have no domain or domain registrar.

• Zoho Books | Product updates | August 2026

  Hello users, July has been an exciting month for Zoho Books! This month, we're excited to introduce HTML PDF Templates, Placeholders as Pills, expanded approval workflows for Sales Returns and Journals, and significant compliance updates across the India,

• Zoho Extensions 101: Building extensions for Zoho People

  Hello developers! Welcome to our new video series on building extensions for Zoho People! If you're new to extension development or looking for guidance on building extensions for Zoho People, you're in the right place. We've curated a series of videos

• Page Not Found error - 404 error

  Hello, I am a first time user of zoho sites.I just published my website dentistinminneapolis.com but its giving me a 404 error.Please look into it ASAP and help with the problem.

• What's New in Zoho POS - September 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 September went. Global Edition of Zoho POS for Retail is here On September 28, 2026, we launched

• New in Cadences: WhatsApp follow-ups, upgraded limits, and options for add-ons

  Hello everyone, We're rolling out two key updates to help you engage better and scale smarter with Cadences in Zoho CRM. Reach customers on WhatsApp, directly from Cadences Previously, Cadences have enabled you to automate follow-ups through emails, calls,

• Announcing new features in Trident for Windows (v.1.43.5.0)

  Hello Community! This release includes a collection of enhancements and feature updates aimed at making your email and collaboration experience smoother. Let’s dive into what’s new! Zoho Desk email notifications as Smart Mail. Zoho Desk Smart Mail is

• How to Manage Two GST Numbers / Two Companies in a Single Zoho Inventory Organization?

  Hi Team, We currently have two separate legal entities: A Proprietorship Firm with its own GSTIN A Private Limited Company with a different GSTIN However, operationally, both companies deal with the same products, and we would like to manage the physical

• How To Implement an Auto-Check-out Feature for Attendance?

  If an employee forgets to check out, the system should automatically check out the employee at 6:30 PM

• Convert an Existing Single Item into an Item with Variants

  Hello Zoho Team, Introducing variants is a great addition to Zoho Inventory. However, we would like to request an option to convert an existing single item into an item with variants. For example, Item A initially comes in only one colour, so we create

• IP Address List > Sigma

  We have developed a ZohoCRM extension that utilizes API calls to our server from Deluge scripts and Widgets. Our API server has IP restrictions in place. To ensure successful communication, we require a list of IP addresses utilized by Zoho's platform

• Default Country list suggestions on CRM is different then on Book; how do/did others address this?

  So I already have a support ticket in for this and waiting for a response but figured I'd ask the community also to see if others experienced the same problems and/or how they went about addressing it because sometimes I feel like I'm going crazy with

• Object-level edit permissions

  Hi, we are currently running into a limitation with permissions inside larger workspaces. Our use case is a central Analytics workspace that contains many tables, Query Tables, reports and dashboards used by different teams. We would like to allow certain

• Convert Sales order to Delivery Challan

  Dear Developer Team, In Zoho books we cannot convert sales order into delivery challan before making invoices. As a service business we have to get the delivery note signed then only we can make the invoice. In Some cases we don't receive a purchase order

• What's New in Zoho Inventory | September 2026

  Hello users, September brings a range of new features and enhancements across Zoho Inventory. From improved inventory operations and reporting capabilities to greater customization, automation, and enhancements to Delivery Challans, there’s plenty to

• Mirror Component in Zoho CRM: Access real-time related data without leaving your record

  Hi everyone, This feature is now available for the JP, CA, SA, UAE, and AU DCs. We're excited to bring to you Zoho CRM's mirror component, which presents relevant data on a record's details page and keeps everything users need in one place without having

• 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. 24

• Create custom rollup summary fields in Zoho CRM

  Hello everyone, In Zoho CRM, rollup summary fields have been essential tools for summarizing data across related records and enabling users to gain quick insights without having to jump across modules. Previously, only predefined summary functions were

• How to mix different types of inputs (such as dropdown list and textbox)

  Hi, I'm creating a form called "Room Reservations" for a company. I created a "table" using "Matrix Choice". I created "Room 1", "Room 2" and "Room 3" with the "Questions". I would then like to create two columns with the "Answers", one called "Department"

• Feature Request: Render Markdown (.md) files in Zoho Cliq

  Hi, We regularly share Markdown (.md) files in Zoho Cliq. However, when we open these files in Cliq, the content does not render as Markdown—it displays as plain text. This forces us to copy/paste the content into an external Markdown viewer to read it

• Dealing With One-Time Customers on Zoho Books

  Hello there! I am trying to figure out a way to handle One-Time customers without having to create multiple accounts for every single one on Zoho Books. I understand that I can create a placeholder account called "Walk-In Customer", for example, but I

• Cash Basis VAT RETURN REPORT Required in Saudi Arabia

  Zoho Books in Saudi Arabia not showing TAX RETURNS report on CASH Basis.. It only showing accrual basis. Oforur requirement is both reports (Cash Basis and Accrual Basis ) , same like indian Edition of Zoho Books showing. CASH BASIS RETURN is our Basic

• Next Page