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 post,

---

1. What is ZRC?
2.  ZRC Methods
3. Use Case
4. Solution
5. Summary
6. Related Links

---

1. What is ZRC?

Zoho Request Client (ZRC) is a built-in SDK in Zoho CRM that provides a unified way to make REST API calls across developer-centric features of Zoho CRM like Client Script, Widgets. Invoking CRM APIs, Connection APIs, and external APIs requires different syntax and separate code for each type. ZRC removes this complexity by offering one common and consistent approach to call all APIs, making client-side development easier and faster.

The following are the key features of ZRC.

1. ZRC works with any CRM API version
2. It supports self domain calls by providing only the API endpoint without specifying the domain
3. Uses a single unified syntax for CRM APIs, custom Connections, and external public APIs. 
4. No authentication handling needed for the same CRM org as ZRC manages it automatically
5. Automatic JSON handling without manual parsing.
6. Supports clean async code with full async-await and promise chaining.

2. ZRC Methods

Click here for more details about ZRC Methods.

3. Use Case - Log call notes and update the Lead status with a button click.

At Zylker, Salespersons often make multiple call attempts before connecting with a lead. Manually recording these attempts and updating the Lead status is often overlooked, leading to incomplete tracking and inaccurate pipeline data. To address this, the Admin wants the following changes:

1. Display a popup to capture call attempt details when a button is clicked and save them as a Note on the current Lead.

2. Also, update the Lead_Status of the current Lead to “Contacted” .

4. Solution

Here, the requirement is to create a note based on the Salesperson's description and update the status of the Lead record.To achieve this, Salesperson's input is collected through a pop-up when a custom button is clicked. The ZRC POST method is used to create a note for the Lead. The ZRC PUT method is used to update the status of the Lead record. As the Client Script has to be triggered with a button click, you should create a custom button and add Client Script from "Create Custom Button" pop-up.

1. Go to Setup > Customization > Modules and Fields. Click Leads and navigate to "Buttons" tab.
2. Specify the details about the custom button, Define action as "Client Script" and click Create.
   

1. This opens Client Script IDE.
2. Enter the following script and click Add in Client Script IDE. 
   

1. // Validate if the script is running on a Lead record page
2. if (!leadModule || !leadRecordId || leadModule !== 'Leads') {
3.     ZDK.Client.showMessage('This script is designed to run exclusively on Lead record pages. Please navigate to a Lead record to use this feature.', { type: 'warning' });
4.     return;
5. }
6. 
   
7. // Display a loader to indicate ongoing background operations
8. ZDK.Client.showLoader({ message: 'Logging call attempt and creating follow-up actions...' });
9. 
   
10. try {
11.     // 1. Create a standardized Note attached to the Lead
12.     var notes_content = ZDK.Client.getInput([{
13.         type: 'text',
14.         label: 'Log Call Details'
15.     },
16.     ], 'Log Call Details', 'OK', 'Cancel');
17.     log(notes_content);
18.     console.log({ notes_content });
19.     const notePayload = {
20.         data: [{
21.             Note_Title: 'Call Attempt Log',
22.             Note_Content: notes_content[0],
23.             Parent_Id: { // Associate the note with the current Lead record
24.                 id: leadRecordId,
25.                 name: leadRecordName,
26.                 module: {
27.                     api_name: leadModule
28.                 }
29.             }
30.         }]
31.     };
32. 
    
33.     const noteCreationResponse = await zrc.post('/crm/v8/Notes', notePayload);
34. 
    
35.     // Check for successful note creation (200 OK or 201 Created)
36.     if (noteCreationResponse.status !== 201 && noteCreationResponse.status !== 200) {
37.         throw new Error('Failed to create Note: ' + JSON.stringify(noteCreationResponse.data));
38.     }
39. 
    
40.     // 2. Update the Lead_Status field to “Contacted” on the current Lead
41.     const leadUpdatePayload = {
42.         data: [{
43.             id: $Page.record_id, // Specify the record to update
44.             Status: 'Contacted'
45.         }]
46.     };
47.     const leadUpdateResponse = await zrc.put(`/crm/v8/${leadModule}/${leadRecordId}`, leadUpdatePayload);
48.     $Client.refresh();
49. 
    
50.     // Check for successful lead status update (200 OK or 202 Accepted)
51.     if (leadUpdateResponse.status !== 200 && leadUpdateResponse.status !== 202) {
52.         throw new Error('Failed to update Lead Status: ' + JSON.stringify(leadUpdateResponse.data));
53.     }
54. 
    
55.     // Display a success message
56.     ZDK.Client.showMessage('Call attempt logged, and Lead status updated', { type: 'success' });
57. 
    
58. } catch (error) {
59.     // Log and display an error message if any step fails
60.     console.error('Error executing Log Call Attempt script:', error);
61.     ZDK.Client.showMessage(`An error occurred: ${error.message}`, { type: 'error' });
62. } finally {
63.     // Always hide the loader, regardless of success or failure
64.     ZDK.Client.hideLoader();
65. }

1. In the above script, $Page.module retrieves the current CRM module from which the script is executed.
2. $Page.record_id fetches the unique ID of the record currently opened on the page.
3. $Page.record provides access to the field values of the current record.
4. ZDK.Client.showLoader() displays a visual loading message to inform the Salesperson that background operations are in progress.
5. ZDK.Client.getInput() prompts the Salesperson to enter details about the call through an input dialog.
6. ZRC.post() sends a POST request to Zoho CRM to create a new record and automatically handles authentication and domain resolution.
7. In the notePayload,"Parent_Id" links the created note to the current CRM record and module.
8. ZRC.put() sends a PUT request to Zoho CRM to update an existing record.
9. $Client.refresh() refreshes the current CRM page so the latest updates are immediately visible to the Salesperson.
10. Here is how Client Script works.
    

5. Summary

1. How to update a record in Zoho CRM using ZRC 

2. How to insert a record using ZRC

3. How to reload the page using Client Script.

6. Related Links

1. Client Script related Kaizen posts
2. ZRC Code Samples
   
3. ZRC Documentation
4. Client Script Overview
5. ZDK Documentation
6. Event dictionary
   
   

Previous Kaizen post : Kaizen #225 - Making Query-based Custom Related Lists Actionable with Lookups and Links  | Kaizen Directory

• Topic Participants

• Maadhari M

  

• 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

• Recent Topics

• Disappointment with Zoho Payments

  Dear Gowdhaman, I am writing to inform you that I am removing Zoho Payments from my website. I cannot continue to disappoint my customers due to the lack of UPI support, as has been the case with my experience so far. Please note that the 0.5% transaction

• Evolução do modelo de ambientes: Dev, Homologação e Produção com pacotes versionados

  Hoje o Zoho CRM já oferece Sandbox, o que é um avanço importante para organizações que trabalham com customizações mais complexas. No entanto, na prática, o modelo atual ainda apresenta limitações significativas quando múltiplas equipes ou consultorias

• Permissões granulares por usuário além do modelo baseado exclusivamente em perfis

  Atualmente, o modelo de segurança do Zoho CRM é fortemente baseado em perfis. Embora funcional, esse modelo apresenta limitações quando equipes possuem variações individuais de acesso dentro do mesmo grupo operacional. Em cenários reais, é comum que usuários

• Add or update lookup field values during Blueprint transition

  Hello everyone, During blueprint transition users can add or modify the value of a lookup field. For instance, if the Tickets module includes a lookup field that connects it to records in the Assets module, agents can link the ticket to the correct asset

• Can you limit SEO penalties by delaying the appearance of a pop-up?

  Google is not keen on pop-ups and has got even less keen on them with the new Core Web Vitals updates. But I like using pop-ups. If you delay the pop-up so it only appears 10 seconds after the page loads, do you avoid Google’s penalties? 

• Adding bank details to the contact through API

  How to add bank-related information to the contact while creating it using API? The account number needs to be encrypted before sending it through API but not sure how to encrypt and get those values. Please guide me in this.

• Restrict Payment Methods

  Allow us to restrict certain payment methods specific for each customer.

• Clone Banking Transaction

  Why is there no option to CLONE a Transaction in the Banking module?? I often clone Expenses (for similar expense transactions each month) so I would also like to clone Income transactions. But there is no option in Banking to clone an existing Income

• PDF limit

  Hello everyone, We have received an e-mail that we have reached our PDF limit. (see screenshot) However, I cannot find any reference to a PDF limit in our tariff plan (Premium). (see screenshot). What is the maximum number of PDFs that can be generated

• How can I see content of system generated mails from zBooks?

  System generated mails for offers or invices appear in the mail tab of the designated customer. How can I view the content? It also doesn't appear in zMail sent folder.

• Credit Card Pre-Authorization with later Capture/Settlement

  We really enjoy the convenience of being able to pay off a customer's invoice using our Auth.Net integration with Zoho Books. Unfortunately, we can only take advantage of this feature with a small percentage of our customers as it leaves a gaping hole

• Accessibility in Zoho CRM: Not just a feature—a way to empower

  For instructions on setting up these controls, please check this help document: Configuring accessibility controls. Hello everyone, Today (December 3, 2024), on the International Day of Persons with Disabilities, we begin our journey towards a CRM that

• Automation Series #1: Round Robin vs Direct Assignment in Zoho Desk

  Direct Assignment vs Round Robin: Choosing the right routing method in Zoho Desk This post is part of the "Desk Automation Series," Chapter 1. Through this series, we will help you choose the right automation type in Zoho Desk by comparing commonly confused

• Invalid tax authority ID.

  How do I correct this ?

• Pay Pal Paylater button

  I am testing the paypal setup to have my customers pay invoices with paypal and credit cards. But it seems to have two options. Paypal and Pay later. I don't want my customers access to pay later feature. How can I turn that part off.. My other integration

• Zoho Workshops are coming to the Netherlands - Join us on 14-16 April in Amsterdam!

  Dear Zoho Community Members, After succesful recent editions in the UK and Scandinavia, we’re pleased to invite you to the upcoming Zoho Benelux Workshop 2026, taking place 14–16 April 2026 in Amsterdam. This three-day, in-person event at the Park Plaza

• 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?

• Sub form auto field population based on parent form

  I have a parent form called "Sites" with a text field called "Site". I have a subform called "Design Comments" (actual form name "Review Comments") with a lookup field name "Sites1" that looks up from the Sites form. I want the Sites1 lookup field to

• Building Toppings #7 - Using schedules and workflow functions

  Hello Biginners, In our previous forum post, we explored install and uninstall actions and learned how to trigger custom logic the moment a topping is added or removed from an organization. In this post, we'll look at how to automate actions during regular,

• Simplify scripting with Zia assistant bot

  Hello everyone, Building automation using Deluge custom functions gives users flexibility and control. Traditionally, creating these functions required writing scripts, testing the logic, and validating the configuration before using it. With Zia assistant

• Zoho Sprints iOS app update: Global view, screen capture control, file encryption, tags enhancement

  Hello everyone! We are excited to introduce new features in the latest version(v2.1) of the Zoho Sprints iOS app update. Let’s take a quick look at what’s new. 1. Global view Global view brings all your project items into one centralised space. You can

• Resource Management System built using Zoho CRM, Creator, Projects, and People:

  In a Resource Management System built using Zoho CRM, Creator, Projects, and People: CRM Deal Closed → Creator Allocation Engine → Zoho Projects Task Assignment What is the recommended architecture to handle dynamic reassignment when: an employee goes

• Request to Remove LinkedIn Verification from My Emai

  I would like to submit a complaint regarding my Zoho Mail account. I previously used this email address to verify a LinkedIn account, but that LinkedIn account has now been closed. I need to remove or cancel the verification associated with the closed

• Pin multiple columns and adjust column widths in CRM subforms

  Hello all, Subforms act as secondary forms or tables in which you can associate multiple line items to a primary record and thereby ensure more structured and comprehensive data organization. We've made some recent enhancements to subforms. Here's what's

• Removing To or CC Addresses from Desk Ticket

  I was hoping i could find a way to remove unnecessary email addresses from tickets submitted via email. For example, a customer may email the support address AND others who are in the helpdesk notification group, in either the TO or CC address. This results

• From Zoho CRM to Paper : Design & Print Data Directly using Canvas Print View

  Hello Everyone, We are excited to announce a new addition to your Canvas in Zoho CRM - Print View. Canvas print view helps you transform your custom CRM layouts into print-ready documents, so you can bring your digital data to the physical world with

• Announcing Kiosk 1.1 - Customize screen titles, configure new fields & actions, use values from your Kiosk to update fields, and more.

  Hello all We are back again with more enhancements to Kiosk. So what's new? Enhancements made to the Components Add titles for your Kiosk screens and adjust its width to suit your viewing preferences. Three new fields can be added to your screen: Percentage,

• CRM Percent custom fields: When will it show the % symbol and behave like %?

  1. Actually Percent custom fields fail to show the % symbol. 2. When in formulas Percent fields work like number: 100 x 5% = 5 ideal world 100 x 5% = 500 what happens actually 3. When importing Percent fields the % symbol has to be removed and the data

• Introducing Color Coding of Picklist Values

  Dear Everyone, Greetings!! Zoho CRM is uplifting the user experience. Recently, we had some notable aesthetic improvements in CRM like Kanban View UI enhancement, New List view UI enhancement, color coding of tags, and color coding of picklists in meetings.

• Where can I find the best mail backup tool for Windows?

  Later this evening I found Mail Backup Tool in google. Actually I was looking for a solution to download/save emails to my local drive. As I had plenty of important data stored in my email account. So i was not in a mood to take this thing lightly. This made me curious to found any software which can help me to backup my data to hard drive. Then I found the above application which was like a gem. A complete email backup solution for Zoho Mail, Gmail, Yahoo Mail, Office 365 and more than 40+ email

• Mailbox storage showing incorrect usage

  My mailbox shows 4.99 GB used out of 5 GB. However, actual mailbox usage is only around 394 MB. Trash and Spam are already empty. IMAP/POP is not enabled. WorkDrive is not in use. This appears to be a storage calculation issue. Please help to recalculate

• Super Admin Logging in as another User

  How can a Super Admin login as another user. For example, I have a sales rep that is having issues with their Accounts and I want to view their Zoho Account with out having to do a GTM and sharing screens. Moderation Update (8th Aug 2025): We are working

• Es posible cambiar el lenguaje de los modulos del ASAP?

  Es posible cambiar el lenguaje de estos textos? Tengo Zoho configurado en español pero aun así me muestra estos textos en ingles:

• Option to Automatically Publish Job Openings to the Career Website via API or Workflow

  Currently, when creating Job Openings using the Zoho Recruit API, the records are successfully inserted into the system. However, there is no way to automatically publish these Job Openings to the Career Website. In the Job Opening field data, there are

• Evaluate applicants faster: Profile Summary and Skill Sets now in Applications

  Evaluating applicants often requires switching between modules to understand their skills and background. With this update, we’ve extended two capabilities directly to the Applications module: Skill Sets and Profile Summary. You can now review applicants

• Free webinar: How to use passkeys with Zoho Vault

  Hi everyone! Passkeys are transforming the way we sign in—making authentication safer, faster, and completely passwordless. No more memorizing complex passwords or worrying about credential theft. With Zoho Vault, you can securely manage both passwords

• Adding Markdown text using Zoho Desk API into the Knowledge Base

  Hi Zoho Community members, We currently maintain the documentation of out company in its website. This documentation is written in markdown text format and we would like to add it in Zoho Knowledge Base. Do you know if there is REST API functionality

• Is it possible to embed Zoho Bookmarks in the Cliq sidebar?

  Is there any way that each Zoho user can access their bookmarks (that live in https://bookmarks.zoho.eu/ which is technically a part of Zoho Mail) directly within Cliq? As a widget, or an item in the sidebar? My team does not use Mail, it uses Cliq all

• Enhancing Zia's service with better contextual responses and article generation

  Hello everyone, We are enhancing Zia's Generative AI service to make your support experience smarter. Here's how: Increased accuracy with Qwen One of the key challenges in AI is delivering responses that are both contextually accurate and empathetic while

• Let us add Lookup fields in the Blueprint Transitions

  We are unable to add Lookup Fields in the blueprint transitions in Zoho Desk, we wanted to make it a requirement for our workflow but since it's not available in the transition we cannot. The lookup field exists in the Layout: But it cannot be added/selected

• Next Page