blungo - Blog #functionblungo - Blog #functionhttps://www.blungo.com/blogs/tag/functionWed, 08 Oct 2025 15:59:45 -0700http://zoho.com/sites/<![CDATA[Working with Multi-Select Look Up fields in Zoho CRM]]>https://www.blungo.com/blogs/post/working-with-multi-select-look-up-fields-in-zoho-crmIn this tutorial, we are going to show you how two different ways to find the Linking Module API fields, and we are going to review an example of how to search for records in a Multi-Select Look Up field.]]>

What we are going to do

In this tutorial we are going to show you how two different ways to find the Linking Module API fields, and we are going to review an example of how to search for records in a Multi-Select Look Up field.


When you create a Multi-Select Look Up fields (MSLU), a new module called "Linking Module" is created. This module holds some basic information about how the two records are related. The Linking Module has it's own API name, so if you want to use it in a function, you have to know the API name. There are 2 ways you can get the API Name: searching in the CRM settings, or using a custom function.

Linking Module API Name

CRM Settings

This is seems like the easy way to do it, but it might be more complicated than using a custom function. The issue with this way is that you have to make some assumptions. Normally, your assumptions will be correct, but there's a small chance that the name of one of the modules linked by the Linking module was changed, and this could conflict with the setup.

Here's how to do it:
  1. In the CRM, go to the setup.
  2. On the search bar, look for "CRM API", and open the first result.
  3. Click on the "API names" sub-tab.
  4. Open any of the modules listed here.
  5. Now, on the "filters by" section, click on the modules field.
  6. If you scroll all the way down, you will find the Linking Modules.



The Linking Module API name is the module name "Contacts X Properties", but you have to replace the spaces with underscores like this "Contacts_X_Properties". Now, if any of the modules' names changed, this method might not work for you.

If you open any Linking Module, you will see the fields related to the module. We are going to use some of the fields in the example that you can find at the end of this article.


Custom function

This method is more complicated, but always gives you the correct Linking Modules API Names.

Add a connection:
  1. In the CRM, go to the Setup.
  2. Under "developer space", click on "connections".
  3. Click on "create connection".
  4. The service is "Zoho OAuth".
  5. Name the connection. We are going to use "linking_module_API".
  6. The scope is "ZohoCRM.settings.modules.ALL". Use the magnifier to easily find it.
  7. Click on "create and connect".
  8. Click on "connect" and allow any permissions you are requested.

Create the function:
  1. In the CRM, go to the Setup.
  2. Under "developer space", click on "functions".
  3. Create a new function with the "new function" button.
  4. Name the function.
  5. The category is "automation".
  6. Click on "create".
  7. Copy the first code listed below (called "Find Linking Modules API Names")
  8. Paste the code in the function.
  9. Replace the connection name with the name of the connection created in the previous step.
  10. Click on "Save & Execute".

The console will give you a list of the Linking Modules API names.
// Finding Linking Modules API Names
get_linking_modules_api = invokeurl
[
url :"https://www.zohoapis.com/crm/v3/settings/modules"
type :GET
connection:"linking_module_api"
];
modules_info = get_linking_modules_api.get("modules");
for each  item in modules_info
{
module_type = item.get("generated_type");
if(module_type == "linking")
{
module_api = item.get("api_name");
info module_api;
}
}

Example: Contacts and Properties Multi-Look Up Field

Let's say we have a custom module called Properties, that is related to the Contacts module. In the Contacts layout, we have a MSLU field where you can select multiple Properties.

If you try to get information from the MSLU using the "get" function, the result will be a string of text with all the Property names combined. There's no JSON with the Properties IDs or names.

Below you will find the function that you can copy and paste. We are going to explain each section individually. Make sure to add "contact_id" as an string in the arguments.

1) property_list = zoho.crm.searchRecords("Contacts_X_Properties","(Property_Contact:equals:" + contact_id + ")");
This line uses the "contact_id" to search for all the properties that are linked to the Contact via the Linking Module. The "Property_Contact" API name can found by following the steps on the first section of this article. This function will return one o multiple results in a JSON.

2) for each  item in property_list
Now we are going over each result, and we will use some functions to get data from the properties.

3) Property_id = item.get("Related_Properties").get("id");
We are getting the property ID using the field "Related_Properties" from the Linking Module.

4) Propert_info = zoho.crm.getRecordById("Properties",Property_id);
Now that we have the property ID, we can search for that property and get all the information related to it.

5) Property_name = Propert_info.get("Name");
From line 4, we can get, for example, the property name.

6) Propery_sq = Propert_info.get("Sq_Footage");
From line 4, we can also get any other information stored in the property. In this case, we are getting the Square Footage.
// Example
property_list = zoho.crm.searchRecords("Contacts_X_Properties","(Property_Contact:equals:" + contact_id + ")");
for each  item in property_list
{
Property_id = item.get("Related_Properties").get("id");
Propert_info = zoho.crm.getRecordById("Properties",Property_id);
Property_name = Propert_info.get("Name");
info Property_name;
Propery_sq = Propert_info.get("Sq_Footage");
info Propery_sq;
}
]]>Thu, 09 Mar 2023 12:24:34 -0800<![CDATA[How to Create a ChatGPT Bot in Zoho Cliq]]>https://www.blungo.com/blogs/post/Create-a-ChatGPT-Bot-Zoho-CliqIn this tutorial we are going to go over how to create a bot that uses the ChatGPT API to respond to our questions. Once the bot is ready, we are going to add it to a channel. You will be able to use the bot directly or through the channel.]]>

What we are going to do

In this tutorial we are going to go over how to create a bot that uses the ChatGPT API to respond to our questions. Once the bot is ready, we are going to add it to a channel. You will be able to use the bot directly or through the channel. We are going to use the ChatGPT-3 API, that is not the latest version. The ChatGPT-4 API is not available at the time of creating this tutorial. Once the newer API version is available, we will edit this article.


If you would like to learn how to create a Slash Command to ask questions to ChatGPT, check out this link.

Pre-requisites

  • An OpenAI account.

Creating the Bot

  1. In Zoho Cliq, click on your profile picture, and go to "Bots & Tools".
  2. On the Bots tab, click on the "Create Bot" button
  3. Name the Bot: for this example we are going to name it "ChatGPT"
  4. Choose the access level: we are going to choose "organization", so anyone in our organization can use this bot
  5. Under Channel Participation, select "Allow users to add this bot to any channel". Also check "Send messages", "Listen to Messages" and "auto-follow threads". This is important because we are going to add the bot to a channel later on.
  6. Optional: add a bot image
  7. Click on "Save Bot"

Adding the Message Handler Code

  1. On the "Bots" tab, hover over the bot and click on "Edit Handlers"
  2. Now click on "Edit Code" below "Message Handler"
  3. Copy the code below.
  4. Paste the code in the code box.
  5. In OpenAI account, go to the settings and click on the "API Keys" tab (or use this link).
  6. Generate a new secret key and copy it.
  7. Back in Zoho Cliq, replace the key "XXXXXXXXXXXX" with the one you generated.
  8. Cliq on Save.

That's it. The bot should be working. To test it, you can use the side chat panel. The first time you try to use it, you will have to grant some permissions first.
//Message Handler Code
response = Map();
question = message;
// Add Open AI token
token = "Bearer XXXXXXXXXXXX";
//
header = Map();
header.put("Authorization",token);
header.put("Content-Type","application/json");
params = {"model":"text-davinci-003","prompt":question,"temperature":0.4,"top_p":1,"max_tokens":256,"frequency_penalty":0,"presence_penalty":0,"stop":{" Human:"," AI:"}};
fetchCompletions = invokeurl
[
url :"https://api.openai.com/v1/completions"
type :POST
parameters:params.toString()
headers:header
detailed:true
];
info "Fetch completions: " + fetchCompletions;
if(fetchCompletions.get("responseCode") == 200)
{
answer = fetchCompletions.get("responseText").get("choices").getJSON("text");
response.put("text",answer);
}
else if(fetchCompletions.get("responseCode") == 429)
{
response = {"text":"I can't help with this. Try asking something else."};
}
return response;

Adding the Bot to a Channel and edit the Participation Handler

  1. Add the bot to the channel, as you would add a user to the channel.
  2. Now go to "Bots & Tools".
  3. On the "Bots" tab, hover over the ChatGPT Bot and click on "Edit Handlers".
  4. Now click on "Edit Code" below "Participation Handler".
  5. Copy the code below.
  6. Paste the code in the code box.
  7. Save the changes.
  8. Go back to the "Message Handler" code, and copy the ChatGTP API Key.
  9. Back in the "Participation Handler", replace the key "XXXXXXXXXXXX" with the one you copied.
  10. Save the changes again.

The bot is ready to answer to any questions you post on the channel. To test it out, just send a message in the channel and wait for the ChatGPT response.
//Participation Handler Code
response = Map();
if(operation == "message_sent")
{
if(data.get("message").get("type") == "text")
{
response = Map();
question = data.get("message").get("text");
token = "Bearer XXXXXXXXXXXX";
header = Map();
header.put("Authorization",token);
header.put("Content-Type","application/json");
params = {"model":"text-davinci-003","prompt":question,"temperature":0.9,"max_tokens":256,"top_p":1,"frequency_penalty":0,"presence_penalty":0,"stop":{" Human:"," AI:"}};
fetchCompletions = invokeurl
[
url :"https://api.openai.com/v1/completions"
type :POST
parameters:params.toString()
detailed : true
headers:header
];
if(fetchCompletions.get("responseCode") == 200)
{
answer = fetchCompletions.get("responseText").get("choices").getJSON("text");
info "answer" + answer;
response.put("text",answer);
}
else if(fetchCompletions.get("responseCode") == 429)
{
 response = {"text":"I can't help with this. Try asking something else."};
}
}
}
return response ;
]]>Sat, 25 Feb 2023 11:39:34 -0800<![CDATA[Create a ChatGPT Slash Command in Zoho Cliq]]>https://www.blungo.com/blogs/post/Create-a-ChatGPT-Slash-Command-in-Zoho-CliqIn this tutorial, we are going to go over how to create a slash command in Zoho Cliq, so you can ask questions to ChatGPT directly in Cliq.]]>

What we are going to do

In this tutorial we are going to go over how to create a slash command in Zoho Cliq, so you can ask questions to ChatGPT directly in Cliq. Once you get the answer, you will be able to post them on any chat or channel. We are going to use the ChatGPT-3 API, that is not the latest version. The ChatGPT-4 API is not available at the time of creating this tutorial. Once the newer API version is available, we will edit this article.

Pre-requisites

  • An OpenAI account.

Creating the Command

  1. In Zoho Cliq, click on your profile picture, and go to "Bots & Tools".
  2. On the left, click on "Commands"
  3. Click on the "Create Command" button
  4. Name the command: for this example we are going to name it "chatgpt"
  5. Add a Hint: for example, ChatGPT answers your questions.
  6. Choose the access level: we are going to choose "organization"
  7. Optional: add an image
  8. Click on "Save & Edit Code"

Editing the Code

On the Execution Handler tab:
  1. Delete the code that is already there.
  2. Copy the code below.
  3. Paste the code in the "Execution Handler" tab.
  4. In OpenAI account, go to the settings and click on the "API Keys" tab (or use this link).
  5. Generate a new secret key and copy it.
  6. Back in Zoho Cliq, replace the key "XXXXXXXXXXXX" with the one you generated.
  7. Cliq on Save.

On the Suggestion Handler tab:
  1. Remove the code.
  2. Click on Save

Testing the Command

  1. Open a chat or channel in Zoho Cliq
  2. Tipe /chatgpt and press Enter
  3. The first time you use the Command, you will have to allow the Command to access certain information. Click on "Proceed to Allow".
  4. Type a prompt. For example, "what is Zoho Cliq?".
  5. Press enter to send the message.
  6. The Command responded to you. The message is visible to you only.
  7. Use one of the options for the message: post it on the chat, forward it to other chats or channels, or close it. If you don't choose any of the options, when you close the chat, the message will be closed automatically.

Code

response = Map();
// Creating the card
card = Map();
card.put("theme","modern-inline");
card.put("title","ChatGTP");
// Add Open AI token
token = "Bearer XXXXXXXXXXXX";
//
header = Map();
header.put("Authorization",token);
header.put("Content-Type","application/json");
params = {"model":"text-davinci-003","prompt":arguments,"temperature":0.4,"top_p":1,"max_tokens":256,"frequency_penalty":0,"presence_penalty":0,"stop":{" Human:"," AI:"}};
fetchCompletions = invokeurl
[
url :"https://api.openai.com/v1/completions"
type :POST
parameters:params.toString()
headers:header
detailed:true
];
info "Fetch completions: " + fetchCompletions;
if(fetchCompletions.get("responseCode") == 200)
{
answer = fetchCompletions.get("responseText").get("choices").getJSON("text");
response.put("text",answer);
}
else if(fetchCompletions.get("responseCode") == 429)
{
response = {"text":"Oops! I can't help with this. Try asking something else :wink:"};
}
// Adding response to the card
response.put("card",card);
//
return response;
]]>Sat, 25 Feb 2023 11:03:58 -0800<![CDATA[Zoho CRM: Execute Function with a Button]]>https://www.blungo.com/blogs/post/zoho-crm-execute-function-with-a-button

In this tutorial we are going to create a button that will trigger a function after we select some records. You can trigger any function you want, but for this example we are going to keep things simple. The button will trigger a function that updates a field.

Part 1: Creating the function

  1. In the set up page, click on "functions" under "developer space"
  2. Click on the "new function" button
  3. Name the function and select Button as the category
  4. Copy the code down below and paste it in the function's body
  5. Highlighted in yellow you will find the part of the function you can replace with your own function.
  6. Now click on "Edit Arguments" and map the argument "id" as a "string"
    1. If you added your own function that has variables, map them in the arguments section as well
  7. Finally save the arguments and save the function
idList = id.toList("|||");
for each id in idList
{
currentDate = today;
update = zoho.crm.updateRecord("Deals",id,{"Contract_signed":currentDate});
}
return "Contract signed date updated";

Part 2: Creating the button

  1. In the setup page, go to "Modules and fields" under "Customization"
  2. Open the module that you are creating the function for. In my case it's the Deals module
  3. On the top, click on "Links and Buttons"
  4. Click on "New Button"
  5. Name the button and add a description if you would like to
  6. Select "List View - Mass Action Menu" as the place were the button is going to be located
  7. The action to perform is "From Existing Actions" under "Functions"
  8. Now click on "Configure" next to the function you just created
  9. Map the "id" parameter to the Deal Id field, pressing #
  10. Save everything and test the button
]]>Thu, 25 Nov 2021 10:07:04 -0800<![CDATA[Function: Count Related Records in Zoho CRM]]>https://www.blungo.com/blogs/post/function-count-related-records-in-zoho-crm

In this tutorial we are going to create a function that will count the related record of a record, and will add the total count to a field that you can use to filter your records or trigger other automations. For this example, we will count how many Deals are related to a Contact, but you can replace the variables to count other related records, even if they are part of a custom module.


This function will trigger when a new Deal is created. So when you create a new Deal, it will find the contact related to that Deal, and it will count how many Deals the Contact has, and then it will place the total number in a field in the Contact.


If you would like to run this function on all the records you currently have, without having to wait for a related record to be created, you will have to create a different function that will update all the records at once. This tutorial doesn't show how to do that.

Part 1: Add a field to the Contacts layout

  1. In CRM, open the set up page, then go to modules and fields under customization
  2. Open your deals module, in my case it's called opportunities
  3. Open the layout you want to edit
  4. Add a user field and name it
  5. Save and close the module
  6. Then, on the setup, go to developer space and click on APIs
  7. On the top, go to APIs names and open "Deals"
  8. On the list, find the field you just created, and take note of the API name


Part 2: Creating the function

  1. In the set up, click on "functions" under "developer space"
  2. Click on the "new function" button
  3. Name the function and select automation as the category
  4. Copy the code down below and paste it in the function's body
  5. Replace "API_name_field" for the API name that you found on step one (where you want to place the total count number)
  6. Find the API name of the module that you would like to count, in my case it's Deals
  7. Replace "API_name_to_count" with the API name found (Deals)
  8. Find the API name of the main module, in my case it's Contacts
  9. Replace "API_name_record" with the API name found (Contacts)
  10. Now click on "Edit Arguments" and map the argument "contactId" as a "string" (you can change the name of this argument if the main module is different; ie: if you are counting products related to a deal, the main module will be Deal, so you can call this field "DEALID")
  11. Finally save the arguments and save the function
relRecords = zoho.crm.getRelatedRecords("API_name_to_count","API_name_record",contactId.toLong());
mp = Map();
mp.put("API_name_field",relRecords.size().toString());
updateResp = zoho.crm.updateRecord("API_name_record",contactId.toLong(),mp);
info updateResp;

Part 3: Creating the workflow

  1. In the setup page, click on workflow rules under automations
  2. Create a new rule, select the Deals module, and name it (we are selecting the Deals instead of the contact because we need to trigger this automation when a Deal is created; you have to select the module that you are counting)
  3. Configure your workflow trigger and conditions:
    1. When > on a record action > at creation
    2. Condition: all Deals
  4. As the instant action, select "function"
  5. Click on "new function" and then select "functions"
  6. Find the function you just created, and click on "configure"
  7. Map the argument "potId" as the deal ID, using the # key
  8. Click on "save and associate" and save the workflow
  9. Test the workflow
]]>Thu, 18 Nov 2021 11:34:13 -0800<![CDATA[Automatically create a project when deal is won (Zoho Projects and CRM)]]>https://www.blungo.com/blogs/post/Automatically-create-a-Zoho-Project-when-deal-is-won-in-Zoho-CRM

How it works

In this tutorial we are going to set up a workflow and a function that will create a project in Zoho Project, after a deal was modified in Zoho CRM. When a user makes specific changes in Zoho CRM, like updating the deal stage, this will trigger a workflow that will call a function, and this function will create the project, as well as transferring information from the deal.

Pre-requisites

Optional

This automation will NOT work if the account field on the Deal is empty. You can manually assign an Account, before wining the Deal, or you can create a workflow to do it. If you choose to create a workflow, here are the steps: https://www.blungo.com/blogs/post/workflow-assign-account-to-a-deal-automatically-zoho-crm

Creating the automation

Part 1: Adding a new connection

  1. In CRM, go to developer space and the to connections
  2. Click on Add new connection, and select ZohoOAuth
  3. Connection name: relateproject
  4. Connection Link name: relateproject
  5. Scope: choose these two variables: ZohoCRM.modules.ALL, ZohoProjects.projects.ALL, and ZohoProjects.projects.CREATE
  6. Click on "create and connect", and when a new window pops up, click on "accept"

Part 2: Adding a new function

  1. In the CRM, go to developers and then functions, and add a new function
  2. Name it "Create Project" and select automation as the category
  3. Copy the function listed below and paste in the function window
  4. Click on "edit arguments", and map the the arguments as shown in the image below the function
    • You need to map: ProjName, Description, TemplateID, PortalName as string and id as int
createMap = Map();
createMap.put("name",ProjName);
createMap.put("description",Description);
createMap.put("template_id",TemplateID);
//custom fields
//end of custom fields
response = zoho.projects.createProject(PortalName,createMap,"relateproject");
info response;
mp = Map();
mp.put("name",ProjName);
datalist = List();
datalist.add(mp);
datamp = Map();
datamp.put("data",datalist);
resp2 = invokeurl
[
url :"https://www.zohoapis.com/crm/v2/Deals/" + id + "/Zoho_Projects/" + response.getJSON("projects").getJSON("id")
type :POST
parameters:datamp.toString()
connection:"relateproject"
];
info resp2;

Part 3: Testing the function

  1. Click on "save and execute"
  2. In the new dialog, add your parameters:
    1. ProjName: Any name you want for the project
    2. Description: Any description
    3. TemplateID: Open the Zoho Projects template and copy the ID from the URL (ie: https://projects.zoho.com/portal/blungo#todomilestones/1600615000000748888/)
    4. PortalName: Open Zoho Projects and find it in the URL (ie: https://projects.zoho.com/portal/blungo#todomilestones/1600615000000748888/)
    5. id: Open a Deal in CRM and copy the Deal ID from the URL
  3. Click on save
If everything went well, you will get a long dialog box on the right, and at the end it will say that the function was successfully executed. If you get any errors, even if the function was successfully executed, you must have missed a step. Please remember that the Deal you are using to test this out has to have an Account related.

Part 4: Adding custom fields

To find custom fields API names from Zoho Projects, please follow this tutorial: LINK

You can reuse the connection you already created earlier on, or you can create a new connection.

A) Once you have the custom field API names:

  1. Right after "//custom fields", paste the following function:
    • createMap.put("ZOHO_PROJECT_FIELD_API",CRM_FIELD_API);
  2. Replace "ZOHO_PROJECT_FIELD_API" with the Zoho Project Field API name of the field you want to map
  3. In the CRM setup, go to "developer space" and the to "APIs"
    1. Click on "APIs names", and then click on Deals
    2. Find the field that you want to map, and copy the API name
  4. Go back to the function, and replace "CRM_FIELD_API" with the API name you just found
  5. Repeat the same steps for as many fields as you want to map
Note: to map a date field, you have to use the following function:
  • createMap.put("ZOHO_PROJECT_FIELD_API",CRM_FIELD_API.toString("MM-dd-yyyy"));

B) Map the arguments

  1. Click on "edit arguments"
  2. For each field you want to map, add one argument line
  3. Copy the "CRM API names" and paste them on the lines you added
    1. ie: createMap.put("UDF_CHAR1",Zoho_Drive_Folder);
  4. Select "string" as type, for all of them
  5. Click on "save"


Finally, save the function by clicking on "Save" on the top right corner.

Part 5: Creating the workflow

  1. Go to the workflows section and create a new one
  2. Name it and relate it to the deals module
  3. When: stage is modified
  4. Condition: stage is Signed (select any stage you want to trigger this workflow)
  5. Instant Action: Function
  6. Click on "functions" and select the function "create project"
  7. Now click on "configure", and map all the fields (press # for merge field)
    1. PortalName: find it in the ZohoProjects URL (ie: https://projects.zoho.com/portal/blungo#todomilestones/1600615000000748888/)
    2. TemplateID: find it in the template URL (ie: https://projects.zoho.com/portal/blungo#todomilestones/160061500000008888/)
    3. The rest of the fields are merge fields from the CRM, including id, which is the Deal ID
  8. Click on "save and associate"
  9. Finally click on Save

Now refresh the deal you want to test this automation on and move it to the signed stage. The new project should be created automatically in Zoho Projects, and all the fields from the CRM should be copied to the fields in Projects. Also the project should be linked to the CRM in the projects section.


]]>Mon, 05 Jul 2021 15:51:00 -0700<![CDATA[Workflow: assign Account to a Deal automatically (Zoho CRM)]]>https://www.blungo.com/blogs/post/workflow-assign-account-to-a-deal-automatically-zoho-crm

Part 1: Creating a function

  1. First, create a generic account that can be used for multiple projects (ie: Won Deals)
  2. Open the account you just created and copy the account ID (ie: 44341800000037248888)
  3. In CRM, go to settings, developer space, functions, and add a new function
  4. Name the function (ie: Update_account_in_deal), and select "automation" as the category
  5. Paste the following code in the new window, and make sure to replace the account ID number:
    • update = zoho.crm.updateRecord("Deals",potid,{"Account_Name":4434180000003728888});
  6. Click on "edit arguments", and add "potid" as an "int"
  7. Save everything

Part 2: Creating the workflow

  1. Go to Workflow rules and create a new rule related to the Deals module
  2. Edit the rule: 
    1. When stage is modified to any value
    2. Condition: Stage is Won
    3. Action: function, and select the function you just created
    4. Then map the field "potid" to the Deal ID using the # key
  3. Save everything
Note: edit the rule settings (When, Condition) to match your preferences. In this case we are using the Stage as the trigger, but it can be any field in the Deals module.
]]>Mon, 05 Jul 2021 12:00:16 -0700