Kaizen#76 - Using ZDK CRM APIs in Client Script
Welcome to another week of Kaizen! In this post, let us discuss about the ZDK CRM APIs in Client Script.
Client Script provides us the flexibility to use its collection of ZDK Client APIs and ZDK CRM APIs. The ZDK CRM APIs invoke the Zoho CRM APIs.
Here is the documentation on the available list of ZDK CRM APIs.
Note:
Every execution of a ZDK CRM API affects your API Credits, as it implicitly calls the Zoho CRM API.
Let us see a few sample Use Cases where ZDK CRM APIs are used.
Use Case:
ABC is a hardware manufacturing company. Consider that you want to achieve the following using Client Script in Detail Page (Canvas) of a custom module named Orders.
- The field Status should be editable only for the profiles "Salesperson" and "Administrator" and should be read-only for all other profiles.
- When the field Status is changed to "Dispatched" , send an email to the customer saying "Your order has been dispatched" and display a message that the email is sent.
- Add a tag "Delivered" to an order when the order status is changed to "Delivered".
Solution using Client Script
In order to send email, add tag and get user details through Client Script, you need to use the appropriate ZDK from the list of ZDK CRM APIs.
To accomplish this requirement, create two Client Scripts as follows.
- Client Script for Detail Page (Canvas) onLoad (for requirement - 1)
- Client Script for Detail Page (Canvas) onChange of field Status (for requirements 2 and 3)
1. Client script for Detail Page (Canvas) onLoad (for requirement - 1)
- Go to Setup > Developer Space > Client Script. Click +New Script.
- Specify the details to create a script and click Next.
Enter the following script and click Save.
var user = ZDK.Apps.CRM.Users.fetchById($Crm.user.id); log(user.profile.name); if (user.profile.name != "Salesperson")&&(user.profile.name != "Administrator") { ZDK.Page.getField("Status").setReadOnly(true); } |
Using ZDK.Apps.CRM.Users.fetchById(), you will be able to fetch the details of the current user. The current user ID is captured using the Client Script Constant $Crm.user.id. So the above script will make the field "Status" a read-only field for all profiles other than Salesperson and Administrator. This ZDK CRM API calls the Get Records API to get the user information.
Here is how the Client Script works for Salesperson Profile users.
Here is how the Client Script works for other Profile users.
2. Client script for Detail Page (Canvas) onChange of field Status (for requirements 2 and 3)
- Go to Setup > Developer Space > Client Script. Click +New Script.
- Specify the details to create a script and click Next.
- Enter the following script and click Save.
var user = ZDK.Apps.CRM.Users.fetchById($Crm.user.id); var record = $Page.record_id; // send email when the order status is "Dispatched" if (value == "Dispatched") { var mail = new ZDK.Apps.CRM.__Actions.Models.Mail(); mail.from = { "user_name": "ABC Industries", "email": "ABCIndustries@ABC.com" }; mail.to = [{ "user_name": user.first_name + " " + user.last_name, "email": user.email }]; mail.subject = "You order has been " + value; mail.content = "Hello" + " " + user.first_name + " " + user.last_name + ", " + "We are glad to let you know that your order has been dispatched"; mail.mail_format = "text"; var response = ZDK.Apps.CRM.Orders.sendMail(mail, recordrecord); ZDK.Client.showMessage("Sent mail to notify that the order dispatch is done.", { type: 'success' }); } // Add tag when the order status is "Delivered" if (value == "Delivered") { var Order = ZDK.Apps.CRM.Orders.fetchById(record); var response = Order.__addTags(["Delivered"]); } |
- Here, sendMail(mail_object, record_id) is the ZDK CRM API that internally calls the Send Mail API and __addTags(arrayOfTagNames) is the ZDK CRM API that internally calls the Add Tags to Records. To capture the current record id, $Page.record_id is used and to fetch the current user details, the constant $Crm.user is used.
- Here is how the Client Script works.
- When the status is updated as "delivered" the tag will be added as shown in the following image.
- When the status is updated as "delivered" the tag will be added as shown in the following image.
We hope you found this post useful. We will meet you next week with another interesting topic!
If you have any questions let us know in the comment section.
Cheers!
Access your files securely from anywhere
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?
Topic Participants
Maadhari M
Sticky Posts
Kaizen #197: Frequently Asked Questions on GraphQL APIs
🎊 Nearing 200th Kaizen Post – We want to hear from you! 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 #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.Celebrating 200 posts of Kaizen! Share your ideas for the milestone post
Hello Developers, We launched the Kaizen series in 2019 to share helpful content to support your Zoho CRM development journey. Staying true to its spirit—Kaizen Series: Continuous Improvement for Developer Experience—we've shared everything from FAQsKaizen #193: Creating different fields in Zoho CRM through API
🎊 Nearing 200th Kaizen Post – We want to hear from you! 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.Client Script | Update - Introducing Commands in Client Script!
Have you ever wished you could trigger Client Script from contexts other than just the supported pages and events? Have you ever wanted to leverage the advantage of Client Script at your finger tip? Discover the power of Client Script - Commands! Commands
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
Interactions Tab in Zoho CRM: A 360° Omnichannel View of Every Customer Touchpoint
Hello Everyone, Hope you are well! We are here today with yet another announcement in our series for the revamped Zoho CRM. Today, we introduce Interactions Tab a new way to view all customer interactions from one place inside your CRM account. CustomersHow to resubscribe a contact marked as "Unsubscribed (Marked by Recipient)" without using a form?
Hello, I have a question regarding Zoho Marketing Automation functionality. Is there a way for an administrator to change the subscription status of a contact marked as "Unsubscribed (Marked by Recipient)" back to "Subscribed" without using a form? Ideally,Linkedin: when Zoho Social is going serious with it?
Hi, it's been said in the past that Linkedin related features in Zoho Social were well behind those of other social networks because of limitations imposed by the platform. Now that we see around my tools (take taplio.com) frankly outpacing ZSocial on5名限定 課題解決型ワークショップイベント Zoho ワークアウト開催のお知らせ(7/24)
ユーザーの皆さま、こんにちは。Zoho ユーザーコミュニティチームの藤澤です。 7月開催のZoho ワークアウトについてお知らせします。 2ヶ月ぶりに、渋谷にて「リアル開催」します！ ▷▷詳細はこちら：https://www.zohomeetups.com/20250724Zoho ━━━━━━━━━━━━━━━━━━━━━━━━ Zoho ワークアウトとは？ Zoho ユーザー同士で交流しながら、サービスに関する疑問や不明点の解消を目的とした「Zoho ワークアウト」を開催します。 Zoho サービスで完了させたい設定やカスタマイズ、環境の整備など……各自で決めた目標達成に向け、How to get fields centered in a form?
Is it possible to center fields in a form? Some of my forms do some don't and it is really not aestheticly pleasing? Any help would be greatly appricated. Thanks, Michael McNeillMake Packages from multiple sales order of a single customer
Our customers sends orders to us very frequently, some times what customer wants is to ship items from 5 to 6 sales orders in a single shipment. it will be very nice if, zoho can implement this function, in which we can select items from other sales orders of the customer.Webhooks and Integration
Hey, I was looking to create automation using webhooks or something equivalent of a trigger based mechanism, to connect it as an integration. But I don't find any relevant APIs to setup these webhooks/notifcations for the "Zoho Books". Can anyone pleaseZoho Books X Zoho Expense
Hello there, Please can you tell me if it is possible to sync from Books to Expense? I much prefer the Expense reports to that of Books and the Credit Card feeds work via expense and not Books for me. However I find books is much better to deal with theABILITY TO LOG INTO CUSTOMER PORTAL
I think it would be very helpful to have a button in Zoho Books to be able to see the customer portal so we can see what they see to help them navigate through the portal. Many times, the customer will call about the portal, but without visibility intoSort, filter & save views for BOOKS PROJECTS
Thanks for all the updates. Our firm uses the module for simple internal project accountancy. This means we do everything from the Projects Section but this isn't user friendly at all. You can't do anything with customized your own fields which basicallyedit input format in custom field - sales order
hi, I want to integrate a custom field (multi line text box) in our sales order. It needs to show upper case and lower case letters, numbers, spaces, hyphens and "/". What do I need to put in the custom format to configure these signs? Thanks, TinaThis transaction type cannot be matched with a line on the statement.
When using the books API https://www.zohoapis.com/books/v3/banktransactions/uncategorized/${transaction.transaction_id}/match I get this error "This transaction type cannot be matched with a line on the statement." What I'm doing is for the uncategorizedFull Text Customization & Translation in SalesIQ Chat Widget Settings
Dear Zoho SalesIQ Team, Greetings, We would like to request an important enhancement to the chat widget customization options in Zoho SalesIQ. Current Limitation: At the moment, only some of the text shown in the chat widget is editable or translatableTimesheets
I wanted to create the timesheets remainder for our team mates who miss out the weekly timesheet entries. While creating the email templates, I couldn't see anything related to timesheets. Since it shows projects Can you help me find and build a oneCan we embed a Kanban Type of report using iframe too?
I tried embedding a report as iFrame but it only appear as List View. It would be helpful if can also embed a Kanban Type of report.Weekly Tips : Save Time with Saved Search
Let's assume your work requires you to regularly check emails from important clients that have attachments and were sent within a specific time period. Instead of entering the same conditions every time—like sender, date range, and attachments included—youBig Things Just Dropped in the SalesIQ Universe: Top Upgrades You’ll Love in Nova’25
Nova'25 has landed, and it’s packed with meaningful upgrades to help you engage smarter, work faster, and scale with ease. Whether you're into proactive messaging, smarter automation, or better admin control, there's something here for everyone. Here'sHidden Fields with Data Pre-Population and Notification Integration in Zoho Bookings Forms
Dear Zoho Bookings Support Team, We'd like to propose a feature enhancement for Zoho Bookings forms that would improve data management and workflow efficiency: the ability to create hidden fields with pre-populated data. Current Functionality: Zoho BookingsTip #37 – How to ensure compliance and accountability using Advanced Session Audit – ‘Insider Insights’
Hello Zoho Assist Community! This week we will be discussing how to strengthen your remote support operations with better visibility and control. Let’s say your support team handles a growing number of remote sessions each day. At the end of the week,Replace an existing zoho show file with an uploaded one.
For Zoho WorkDrive Upload API method, I have override-name-exist option, which I can use like this: curl https://www.zohoapis.eu/workdrive/api/v1/upload \ -F "filename=mypres.pptx" \ -F "parent_id=j3tzq1ae09c0cd91540df8d01670af05b657e" \ -F "override-name-exist=true"Tip of the Week #66– Use internal comments to collaborate and resolve issues faster!
Ever found yourself stuck on a customer query because you needed inputs from your teammate? Or sent a reply too soon and realized later that someone else on your team had a better context? When you rely on back-and-forth messages in external chats orUsing Zoho One to manage two (or more) businesses
We are one company that operates two business, a scenario that Zoho One doesn't really seem to handle very well, and one which I can't imagine is at all unique to us! (It is basically designed to facilitate branding and use for one business only per subscription).Skip order confirmation step in commerce?
We have a store to sell products that are not shipped to a customer. Right now, when the order is placed, we have to manually 'confirm' the order so the sales order can convert to an invoice and charge the customer. Is there a way to skip the manualFree Shipping Coupon - Zoho Commerce
I love the Zoho platform. Zoho Commerce is no exception; however, I'm struggling with a few common features I cannot find or are missing that I hope someone can help me with. Is there a way to create a coupon code for free shipping?Is there a way to link an item to a liability account?
I collect customer deposits for certain services and hold them in a liability account. However, Zoho Books doesn't let you create an item and assign it to a liability account so how do I create an invoice with an item that records it as a deposit intoSelect a balance sheet account when creating an invoice
Hi, it would be very helpfull to be able to select a balance sheet account when invoicing clients. We bill 30% of the job at signing and we would like to add to deferred revenues. I have to create a transit revenue account and then tranfer to the rightHow to work out commission in zoho commerce based on coupons
HI There Is there any way to produce report based on coupon name in zoho commerce We need to pay commission to various channels who are helping us to increase the online sales so we have number dedicated coupons assigned to the above mentioned channelsRequest for Subform Styling Feature in Zoho CRM Canvas
Dear Zoho CRM Team, We have observed that in the Zoho CRM Canvas view, it is currently not possible to set presets or manage the styles of subform fields. Additionally, the ability to edit subform data directly within the Canvas view appears to be limitedHow to Delete Old Tasks/Streams Assigned by Deactivated Users? 'Operation Not Permitted' Error
Hello, I’m using Zoho Mail and have several old tasks assigned to me in Tasks and Streams. These tasks were created by former employees whose accounts are now deactivated. When I try to delete these tasks, I get an "Operation Not Permitted" error. TheseZoho Books - Sales Person Contact Details on Quotes
Hi Zoho Books Team, I've had various clients ask me about showing the phone number and email of the sales person on Quotes to help eliminate any barriers to closing sales. When I tell them that it is not possible they are always surprised and say somethingRelated products category instead recommended products.
Hi there, It is possible to show related products of the same category (as it works in the rest of the ecommerce) instead of showing recommended products.Uploading PDF files
How do I upload a PDF file to my ZOHO site?How to send invoices to 2 emails?
Hi! We are sending invoices to the "Customer email" field that is defined Zoho Books and is obtained/synced from a custom email field in Zoho CRM. But in some clientes, the invoices have to be sent to 2 emails and we are wondering how this could be accomplished.It returns 1 record
Var1= Tools_Request[Liability_Receipt == input.Liability_No]; for each rec in Var1.Tool_Request_Description { Var2= (ET_Inventory[SKU == rec.Tools_SKU].SKU).getAll(); } info call for Var2 It only fetch 1 record On record fileNarrative 5: The essential role of SLAs
Behind the scenes of a successful ticketing system - BTS Series Narrative 5: The essential role of SLAs Every organization that interacts with customers establishes a timeframe within which agents should respond to queries as part of a service level agreementNextdoor Integration
Does Zoho social work with Nextdoor? www.nextdoor.com? Are there any plans for an integration?My email sending has beed blocked due to high bounce rate. NEED HELP
User ID: 886739811 Dear Zoho Team, I hope this message finds you well. My account (User ID: 886739811) was blocked from sending emails last week due to an unusually high bounce rate. This spike was caused by a bot attack on our platform, which led toCan Zoho CRM Emails be used in Zoho Analytics in any capacity?
We're wanting to display details about Lead Activity in regular reports through Zoho Analytics but we're having difficulty integrating Emails at all. We'd like to be able to note when an email is received and when it is sent somewhere other than justIF Statement in Zoho CRM Formula Field
Hi, I am attempting to write a formula field that will give me one result if one statement AND another statement are true, then a different value if the first statement AND a different statement are true, else 0. Stated differently: if account = destinationScheduled Maintenances
Hi, Why is adding scheduled maintenance so arduous. It should be a simple process and take very little time for basically a recurring job. Creating 3 records with similar data seems crazy to me. Is there a easy way to do this? I have to create hundredsNext Page