Kaizen #90 - CRM Variables and APIs

Hello everyone!

Welcome back to another post in the Kaizen series!

This week, we will discuss what are CRM Variables and variable groups, how to create, update, and delete them through an API and the UI, and a simple example in Deluge of using a CRM variable in a function. 

Let's get started!

What are CRM Variables?

Often, we have the need to reuse certain data in CRM at various places. Instead of creating separate fields to hold such values in every module, we can create an org-level field and use the same value across the CRM system. This field is called a CRM Variable. 

These variables can be of any of the following data types:

• Decimal
• Single line
• Multi line
• Integer
• Long integer
• Percent
• Currency
• Date
• DateTime
• Email
• Phone 
• URL
• Checkbox

Where can you use CRM Variables?

You can use CRM variables in mail merge templates, email templates, functions, workflows, buttons etc,.

What are Variable Groups?

When you have multiple variables, you can group them together for easy accessibility. For example, it makes sense to group all the authentication variables such as access token, refresh token etc., under a group called "Auth parameters".

How can you create a CRM Variable?

You can create CRM Variables from the UI or through the CRM API.

1. From the UI

1. Go to Setup > Developer Space > Zoho CRM Variables > Create New Variable.
2. In the Create Zoho CRM Variable pop up, enter the following details:
   a. The name of the variable in the Variable Name field.
   b. The API name of the variable in the API name field.
   c. A brief description of the variable in the Description field.
   d. The data type of the variable from the Variable Type drop-down.
   e. The group that the variable must belong to in the Grouped Under drop-down.
3. Click Save.
   

2. Creating a variable through an API

Request URL: {api-domain}/crm/{version}/settings/variables

Request method: POST

Scope: ZohoCRM.settings.variables.ALL or ZohoCRM.settings.variables.CREATE

Input JSON keys

{     "variables": [        {             "name": "Company Address",             "api_name": "Company_Address",             "variable_group": {                 "api_name": "General",                 "id": "3652397000004992001"             },             "type": "textarea",             "value": "#24, Austin, TX",             "description": "The address of the company when the state is Texas"         }     ] }

where,

Key name and data type	Description
name string, mandatory	The name of the variable.
api_name string, mandatory	The API name you want to set for the variable.
variable_group JSON object, mandatory	The API name and the ID of the variable group you want to group your variable under. If you do not have a variable group, you can only group it under "General". Use the Get Variable Groups API to get the ID and name of the variable group.
type string, mandatory	The data type of the variable. The possible values are integer, text(for single line), percent, decimal, currency, date, datetime, email, phone, url, checkbox(for Boolean), textarea(for multi-line), and long.
value string, mandatory	The value of the variable.
description string, optional	A short description of the variable.

Sample Response

How can you update a CRM variable?

1. From the UI

1. Go to Setup > Developer Space > Zoho CRM Variables.
2. Hover over the variable you want to edit. 
3. Click the "Edit" icon on the left-corner of the variable.
4. In the Edit Zoho CRM Variable pop up, update the relevant details.
   
   
5. Click Save.

Note

You cannot edit the Variable Type and Grouped Under fields.

2. Through an API

Request URL: {api-domain}/crm/{version}/settings/variables (or)

{api-domain}/crm/{version}/settings/variables/{variable_API_name or Variable_ID}

Request method: PUT

Scope: ZohoCRM.settings.variables.ALL or ZohoCRM.settings.variables.UPDATE

Input JSON keys

Note that besides "id", all the keys are optional based on what details you want to update.

{     "variables": [        {  "id":"3652397000012482002";             "name": "Company_Address",             "api_name": "Company_Address",             "value": "#24, Austin, TX",             "description": "The address of the company when the state is Texas"         }     ] }

where,

Key name and data type	Description
id string, mandatory	The ID of the variable you want to update. You can get this ID from the Get Variables API.
name string	The name of the variable.
api_name string	The API name you want to set for the variable.
value string	The value of the variable.
description string	A short description of the variable.

Sample Response

How can you delete a CRM variable?

1. From the UI

1. Go to Setup > Developer Space > Zoho CRM Variables.
2. Hover over the variable you want to delete. 
3. Click the "Delete" icon on the left-corner of the variable.
   
   
4. Click Delete in the pop up that asks for confirmation.

2. Through an API

Request URL: {api-domain}/crm/{version}/settings/variables/{variable_id} (or) 
                       {api-domain}/crm/{version}/settings/variables?ids=id1,id2..

Request method: DELETE

Scope: ZohoCRM.settings.variables.ALL or ZohoCRM.settings.variables.DELETE

Sample Response

Use cases

Here are a few use cases where you can use CRM Variables.

• Consider that you have integrated with RazorPay and want to send payment links to deals that you have won. Here, you can store the payment link in a variable and use it in the function that sends the link to the deal through an email.
• You can improvise the above function, and have a condition that checks whether the payment link is valid or has expired. If it is invalid or expired, you can send an alternate payment link that is stored in another CRM variable.
• Consider you have scheduled a function to run everyday. Now, you want to run this function except on Saturday and Sunday of a particular month. In this case, you can hard-code the Saturday and Sunday in CRM variables of the DateTime type, and check this while running your function. You case would be "if datetime =={CRM variable}, stop execution".
• Another classic example of using CRM Variables would be in the banking sector. Consider that you have multiple modules that deal with the rate of interest. This rate will differ based on the tenure, the type of loan, the age of a person etc, and used at multiple places across the org. Here, you can set up variables for the different rates of interests and use them in various places. The best part is, when the rate of interest changes, you have to just change it at one place - CRM Variable. 
  

Let us see this example in detail.

I have a module called Loans. For home loans, the rate of interest is 10% for all, irrespective of the tenure. 

So, I have created a CRM variable called Interest, whose data type is decimal, and has the value 10.

In the Loans module, I have the following fields:

• Customer Name(single line) to represent the name of the customer who has opted for the loan.
• Principal(decimal) to represent the principal they have borrowed.
• Tenure(number) that depicts the number of years they will repay the loan in.
• EMI(decimal) to represent the monthly installment.
• Total(decimal) to represent the total amount they will repay including the interest.

I have a function that calculates the EMI and the Total. Here is the code.

// In this function, we are getting principal, tenure and record id from the record and Interest from CRM Variables.  //Calculate Total  Total = Principal + Principal * Interest / 100 * Tenure; info Total; //Calculate EMI  EMI = Total / (Tenure * 12); info EMI; //Variable with MAP type to hold the fields and values record_info = {"EMI":EMI,"Total":Total}; info record_info; info zoho.crm.getRecordById("Loans",record_id); //Updating the record zoho.crm.updateRecord("Loans",record_id,record_info);

The following image shows the function argument mapping.

I have now set up a workflow that is triggered upon record creation. This workflow has the Calculate EMI function associated to it as shown in the following image.

As you can see, in Argument Mapping, I have chosen the CRM variable Interest.

Here is a demo of how the workflow is triggered and function execution.

As you can see, based on the value in the CRM variable, the Total and EMI is calculated through the function triggered by the workflow upon record creation.

We hope you liked this post. We will see you next week with another interesting topic.

Please let us know if you have any questions in the comment section or write to us at support@zohocrm.com.

Cheers!

• Topic Participants

• Shylaja S

  

• 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

• Zoho Campaigns Account Keeps Shutting Down

  Hey hey, I am completely at a loss here. For months we have been back and forth with Zoho Campaigns Support on Spam Trap hits. Each time they can never provide us with a full list of emails, only 1 here or there. So internally we have setup a integration

• What’s New in 2025 (So Far)

  Hey Recruiters, We’ve wrapped up the first half of 2025 with a few focused enhancements in Zoho Recruit—all aimed at simplifying your day-to-day recruitment tasks. Here’s a quick video that walks you through what’s new so far this year: Here’s a brief

• Multi-Department Approval for a Single Bill in Zoho Books

  Hello everyone, Hope you're all doing well. I’d like to ask if anyone has found a good workaround for the following scenario in Zoho Books: Let’s say a corporate credit card bill or vendor invoice covers multiple purchases across different projects or

• Zoho Landing Page "Something went wrong" Error

  Hello, Every time I try to create a new landing page, I receive a "Something went wrong" error with no explanation. I cannot create any new pages, which means we cannot use this application. I did create one landing page successfully over a month ago,

• Composite items are not seen in zoho commerce

  Composite items are not seen in zoho commerce. Are you scheduled to fix this error?

• not able to access Zoho from home WIFI

  for some reasone i am not able to access Zoho on my laptop or my iphone while i am connected to my home Wifi, i am able to access these sites both on laptop as well as Iphone and associated apps on any other Wifi as well as when I am on my 4G connection

• Zoho Books for Service Enterproses

  I would like to know how to use Zoho Books for services such as car rental, travel agency, and hotel services. I notice that Zoho Books is good for goods, but for services, it's very difficult to track the profit or loss on each invoice. I need to capture

• Email Relay in Zoho Books

  I have set up the email relay in Zoho books and the SMTP test was successful. However, I can't figure out how to sent the POs and invoices via the relay so the copy of the message shows in google workspace sent mail. Any guidance is appreciated

• E-invoicing/Facturacion Electronica in Peru, SUNAT authority

  Hi Zoho, you are promoting your product very actively in south america as well as in Peru, but since few years there is an obligation for e-invoicing, transmitting information directly to peruvian tax authority SUNAT. Do you have any solution for this?

• Project Accounting

  Hello Zoho, Can we also bring project accounting in Zohobooks as a ne feature in upcoming developments? This will be helpful for specific business and industries. Thanks

• Accounts Payable

  hi there  i am using the free version to trial the software. I am working on the acrual basis. When i received a vendor invoice, it gets keyed into the systems as an unpaid invoice as the payment to from the vendor is 14 days. the unpaid invoice does

• Approval Processes "Record Modification"

  I didn't find any information about the "Record Modification" item in Zoho articles and Tutorials. I see that this item didn't exist a year ago. Help understand how it works, I tested it and didn't see any difference between "all fields" and "no fie

• How do i add another purchase information heading?

  i would like to add another section right here to enter an amount which then link directly to the cost of goods sold account

• Help with Zoho CRM API Integration in C# WinForms (Token Generation Issue)

  Hi everyone, I need your help with integrating the Zoho CRM API into a C# desktop application. My goal is to build a WinForms app in Visual Studio that does the following: Fetch the full list of client projects (module: Deals) and display them in a searchable

• Can we share the URL of My zoho Sheets on other websites?

  Hello everyone? I have sheets on Zoho and I want to share them on other websites like daraz, homeshopping, gepco duplicate bills, etc. I don't have much knowledge about online sharing question forums? I am a student and have a short survey about online

• Add Support to Upload Inventory Items with Categories or Enable Separate Upload for Inventory Categories

  Currently, Zoho Inventory does not support uploading new items along with their parent and sub inventory categories using the item import feature. This creates challenges for businesses with structured inventory hierarchies when trying to upload items

• in zoho books while categorizing need to add new name in category by replacing expanses how to edit or make changes need assistance

• Tip of the Week #62– Use @mentions to loop in teammates.

  Ever been stuck on a customer query because you needed input from someone else on your team? Maybe you were unsure about a refund policy or needed help answering a technical question. So you forward the message … and wait. Or worse, you forget to follow

• Suggestions for Kiosk Functionality Improvements in Zoho People

  Hello Zoho Team, I’d like to share some feedback and suggestions regarding the Kiosk functionality in Zoho People, as there are two important points that affect user experience and compliance: Visual Confirmation of Check-In Status It would be extremely

• Needs Separate Permissions levels for Record Attachments

  Currently in Zoho Books Record attachments are tied to the general permission level For example if a role don't have the delete permission level they cannot delete the attachment as well If a role doesn't have the edit permission they cannot upload the

• Zoho Books integration with Google workspace

  How do I integrate Zoho books with Google Workspace? The steps outlined on the Zoho help sections do not correspond to the actual user interface in Google Workspace. Zoho books is installed on admin level for all users, all users can access it from the

• Fields of Look up in Custom Modules

  We need to create a custom module in Books for Proforma Invoices Now I created a Custom Module and added a Table and in the table added a lookup field and chose Items Now I want Specific fields of the item such as Tax, Item Cost etc but it only displays

• Share work items across projects and users

  Hello everyone, We're thrilled to introduce a new feature in Zoho Sprints: "Share work item" Collaboration across projects and users is now easier with the introduction of the Share work item feature. You can now share work items with users who are not

• Payment Terms Changing Upon Invoicing

  Hello! Our standard payment terms for 95% of our customers are Net 30, and all of our customers that these terms apply to have that setting n their customer profile. However, over the last week or so, when an invoice is generated the majority of these

• How do I get a refund for email seats?

  Hi, I've been using Zoho for awhile and have been paying for 2 seats. Recently, I created another 9 seats, but I also found out that Zoho does not support cold emails, so these 9 seats created for this purpose became useless. It's within 24 hours that

• Work Orders / Bundle Requests

  Zoho Inventory needs a work order / bundle request system. This record would be analogous to a purchase order in the purchasing workflow or a sales order in the sales cycle. It would be non-journaling, but it would reserve the appropriate inventory of

• Narrative 1 - The significance of a business account

  Behind the scenes of a successful ticketing system - BTS Series Narrative 1 - The significance of a business account Setting up a proper business account is a crucial step that is often overlooked when launching a ticketing system for your service company,

• Changed hosting for domain, Zoho mail stopped working.

  I have changed hosting fro my domain and from that time my zoho email stopped working

• we need to add a Customer Number field to the PDF document templates

  Hello everyone. We are currently using Zoho Inventory for our small business operations and have found it to be a valuable tool. However, we’ve encountered a specific requirement: we need to add a Customer Number field to the PDF document templates (such

• Joining Two Reports

  Hello Guys, I have three modules: - Orders - Custom module - Clients - Contacts - Basic Pay I am using the order module to store the revenue share amount for each order which will be paid a sales rep The Orders are child or clients so I am pulling a report

• Power of Automation :: Notify users Automatically when @Mentioned in Tasks Description

  Hello Everyone, A custom function is a software code that can be used to automate a process and this allows you to automate a notification, call a webhook, or perform logic immediately after a workflow rule is triggered. This feature helps to automate

• Recording a payment in foreign currency not allowed

  Hi, my base currency is CHF. I made an invoice in EUR, which have been paid with an extra amount (which are the fees I guess). When I record that payment from the invoice page, I can select the EUR bank account. But the amount received is above the invoice

• Introducing WhatsApp integration and quick editing capabilities in Zoho Sign

  Hi there, Zoho Sign already helps users collect signatures via email and SMS, and we're happy to announce that you can now send documents and authenticate recipients right through WhatsApp. Some of the key benefits include: Communication with recipients

• Order Wise Expense Tracking and Reporting Possible?

  Hi, We are a manufacturing firm and take up several orders at the same time. Each order will be associated with a single sales order and then once completed to a single invoice. When recording expenses, is it possible to associate each expense with a

• Layout Rule Fields Appear in "Verify Details" Pop-up — Confirmed Working

  Hey everyone — just wanted to share a quick discovery. I created a Layout Rule in the Deals module that makes two fields show up (and required) when the stage is set to Closed Won or Closed Lost — one pick list and one text field. To my surprise, those

• Can you please let us know how we can use Zoho for multi store?

  Hello Team, Can you please let us know how we can use Zoho for multi store because when we connect our plugin to Zoho and we create a product and then on another store when we create product with same name then product already exist error occurs, so how

• Zoho One Home Dashboard - My Tasks (Projects) & My Overdue Work Items (Projects) have no data.

  The title basically covers the situation. I've set up the dashboard cards, and for a while, they were showing data. Now, they are both blank. Is anyone else experiencing this, or has anyone else experienced this, and if so, is there a fix?

• Zakya - Release in North America?

  At Zoholics it was pitched like Zakya was already released in North America. However, when looking for it I couldnt find it. There isnt an integrated app available in Zoho. I figured maybe it was being released at Zoholics. Now over a month later, its

• Custom Field Mapping in Outlook

  I have 10 custom fields in Zoho is there a way to create and map them to the outlook contact?

• Enhanced Zoho CRM and Office 365 calendar synchronization features!

  Dear customers, We're excited to share some significant improvements to our Office 365 calendar synchronization features, aimed at providing you with more control and a more personalized experience. What’s new Choose your Office 365 calendar: During the

• Next Page