How to call Zoho CRM APIs using Client Script

Welcome back to another exciting Client Script post!

In this post, we will discuss one of the most frequently asked questions: How do you call Zoho CRM APIs from Client Scripts?

In this kaizen post,

1. Ways to make calls to Zoho CRM APIs using Client Script

1.A Client Script ZDK CRM APIs

1.B. Using Connections

2. Requirement

3. Solution

3.A. Create a Connection

3.B. Invoke API using Client Script

4. Summary

5. Related Links

1. Ways to make calls to Zoho CRM APIs using Client Script

1.A Client Script ZDK CRM APIs

You can use the available Client Script ZDK CRM APIs to call v2 APIs directly from within your Client Script.
To view this documentation, click on the help icon next to CRM API in the Library Section of the Client Script Editor. Here is how the screenshot of the documentation looks.

Here is the screenshot of documentation on Client Script ZDK CRM APIs.

Note that this will also affect your API credit limits.

1.B. Using Connections

For calling other Zoho CRM APIs(other than the APIS covered in Client Script's ZDK CRM API) or third-party services, you will have to use Connections along with Client Script. In this post, let us see how to call Zoho CRM APIs. Check the Kaizen post on Third Party Integration using Client Script to know how to call Third Party APIs from Client Script.

2. Requirement

To retrieve all open deals for the currently viewed account.

3. Solution

To fetch app open deals for an account, you can use COQL API. You can also use the Related Records API, get deals of a given account ID, and then filter the open deals.

But COQL API is recommended due to the following reasons.

- There is no indexing delay.

- You can use comparators such as is null, is not null, between, in, not in, like, and not like in your search query.

- You can fetch data from other lookup modules if any. Click this Kaizen Post for more details.

To accomplish this requirement, create a connection with the scopes for the API you want to call and create a Client Script

3.A. Create a Connection

To setup Connection, follow the below steps.
In Zoho CRM, go to Setup → Developer Hub → Connections and click "Create Connection".

Select Zoho OAuth in Default Services and click "Create and Connect".

Specify a name for the Connection and select the Scopes required for COQL API.

ZohoCRM.coql.READ (and) ZohoCRM.modules.READ
(or)
ZohoCRM.modules.{module_name}.{operation_type}

Click Create and Connect.

3.B. Invoke API using Client Script

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 acc=$Page.record_id;
var parameters = {
"select_query": `SELECT Stage,Account_Name.id from Deals where Stage not in ('Closed Lost','Closed Won','Closed - Lost to Competition') and Account_Name.id = ${acc}`
};
var response = ZDK.Apps.CRM.Connections.invoke("c", "https://www.zohoapis.com/crm/v6/coql", "POST", 2, parameters, {});
log(JSON.stringify(response));

You can invoke COQL API using Connections in Client Script using invoke() method.

Click here to know more about the Connections.

Here ,

Connection name is test
url is https://www.zohoapis.com/crm/v7/coql
method is POST
param_type is 2
parameters is the query stored in parameters variable.
headers - there are no headers in this case.

Summary

In this post we have discussed the following.

1. How to call COQL API using Client Script

2. Steps involved to include the scopes via Connection

3. Advantages of COQL API

Related Links

Previous Post: Kaizen #164 - Leveraging ZDK CLI with VCS | Kaizen Collection: Home

Zoho Desk Resources

Desk Community Learning Series
Digest
Functions
Meetups
Kbase
Resources
Glossary
Desk Marketplace
MVP Corner
Word of the Day

Topic Participants
Maadhari M

Sticky Posts
Kaizen #165 : How to call Zoho CRM APIs using Client Script
Welcome back to another exciting Client Script post! In this post, we will discuss one of the most frequently asked questions: How do you call Zoho CRM APIs from Client Scripts? In this kaizen post, 1. Ways to make calls to Zoho CRM APIs using Client
Kaizen#162 : Add Tags and Open Pre-filled Email Drafts via Client Scripts
Hello everyone! Welcome to another informative Kaizen post. In this post, let us see how to accomplish the following using Client Script. 1. How to auto-tag a record based on field update? 2. How to Open a pre-filled email draft This post will provide
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
Extension Pointers - JS SDK series #4: Managing data from a widget using ZOHO.CRM.HTTP
Handling and managing the data between two applications is a major factor for an efficient business. There are a variety of ways to handle data between Zoho CRM and other third-party applications. You can use deluge CRM tasks, create connectors, use API
Kaizen #152 - Client Script Support for the new Canvas Record Forms
Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achieved