Kaizen #68 - Scoring Rules APIs[Part 1]
Hello everyone!
Welcome to another week of Kaizen!
This week we will discuss the Scoring Rules APIs.
What are scoring rules?
You may have different strategies to engage with customers, make their journeys successful in your business, and to convert them to potentials soon.
Scoring each lead based on certain criteria helps you determine who is likely to become a valuable potential.
These criteria or rules are called scoring rules.
When should you use scoring rules?
- When there are multiple decision makers. In a B2B model where the sales cycle in the business model is long, it is important to have scoring rules for every touchpoint so that you can identify/track the deals with the highest conversion potential and move these deals quickly down the funnel.
- In a multi-product and cross-selling business, you need to score leads based on the different products they are interested in, and then engage them in cross-products.
- When you have multiple customer touchpoints. For example, your business may use strategies such as email campaigns, surveys, webinars, training sessions etc. Scoring the customers separately for each touchpoint gives you a more detailed insight into their interests and decide the best engagement strategy.
Note
- You can configure scoring rules for Leads, Accounts, Contacts, Deals, and custom modules.
- Scoring rules are layout-specific and each layout can have up to five rules.
For more details, refer to this help page.
Let us now understand how to configure a scoring rule, update, delete, and execute a scoring rule through APIs.
Consider that you have configured Emails to use email insights and have integrated with Zoho Campaigns, Telephony, and Zoho Survey. You want to score the leads based on their responses to these touchpoints, besides scoring them based on their position in the company.
Here is an example of how you can score based on the various touchpoints:
- 10 points for opening an email
- -5 when the email bounces
- 10 points for responding to a survey
- 10 points for opening a campaign
- -10 for not responding to calls
- 10 points when the Position is Decision Maker or Regional Manager
Here, scoring based on the custom picklist field "Position" is the field rule, while scoring based on the integration and insights is called the signal rule.
Let us see how to achieve this through the Scoring rules API.
Create a Scoring Rule
Request URL: {api-domain}/crm/v4/settings/automation/scoring_rules
Request Method: POST
Scope: ZohoCRM.settings.scoring_rules.ALL/CREATE
Supported Modules: Leads, Contacts, Accounts, Deals, and custom
Sample Input
{ "scoring_rules": [ { "name": "Rule 2", "description": "Rule for Module Leads", "module": { "api_name": "Leads", "id": "3652397000000002175" }, "layout": { "api_name": "Standard", "id": "3652397000000091055" }, "active": false, "field_rules": [ { "score": 10, "criteria": { "group_operator": "OR", "group": [ { "field": { "api_name": "Position" }, "comparator": "equal", "value": "Regional Manager" }, { "field": { "api_name": "Position" }, "comparator": "equal", "value": "Decision Maker" } ] } } ], "signal_rules": [ { "score": -5, "id": "3652397000010473049", "signal": { "namespace": "EmailInsight_Bounce__s", "id": "3652397000000112025" } }, { "score": -10, "id": "3652397000010473050", "signal": { "namespace": "Telephony_Missed__s", "id": "3652397000000112027" } }, { "score": 10, "id": "3652397000010473051", "signal": { "namespace": "EmailInsight_Open__s", "id": "3652397000000112021" } }, { "score": 10, "id": "3652397000010473052", "signal": { "namespace": "Survey_Responded__s", "id": "3652397000000112029" } }, { "score": 10, "id": "3652397000010473053", "signal": { "namespace": "Campaign_Open__s", "id": "3652397000000112031" } } ] } ]}
{
"scoring_rules": [
{
"name": "Rule 2",
"description": "Rule for Module Leads",
"module": {
"api_name": "Leads",
"id": "3652397000000002175"
},
"layout": {
"api_name": "Standard",
"id": "3652397000000091055"
},
"active": false,
"field_rules": [
{
"score": 10,
"criteria": {
"group_operator": "OR",
"group": [
{
"field": {
"api_name": "Position"
},
"comparator": "equal",
"value": "Regional Manager"
},
{
"field": {
"api_name": "Position"
},
"comparator": "equal",
"value": "Decision Maker"
}
]
}
}
],
"signal_rules": [
{
"score": -5,
"id": "3652397000010473049",
"signal": {
"namespace": "EmailInsight_Bounce__s",
"id": "3652397000000112025"
}
},
{
"score": -10,
"id": "3652397000010473050",
"signal": {
"namespace": "Telephony_Missed__s",
"id": "3652397000000112027"
}
},
{
"score": 10,
"id": "3652397000010473051",
"signal": {
"namespace": "EmailInsight_Open__s",
"id": "3652397000000112021"
}
},
{
"score": 10,
"id": "3652397000010473052",
"signal": {
"namespace": "Survey_Responded__s",
"id": "3652397000000112029"
}
},
{
"score": 10,
"id": "3652397000010473053",
"signal": {
"namespace": "Campaign_Open__s",
"id": "3652397000000112031"
}
}
]
}
]
}
Key | Description |
name string, optional | Unique name of the scoring rule. Accepts up to 25 alphanumeric characters. |
description string, optional | Description of the scoring rule. Accepts up to 500 characters. |
module JSON object, mandatory | API name and ID of the module you want to create this rule in. Use the Modules API to get the module's API name and ID. |
layout JSON object, mandatory | The API name and ID of the layout in the module you want to create the scoring rule on. Use the Layouts Metadata API to get this ID. |
active boolean, optional | Represents if you want to activate the scoring rule right after creation. The default value is true. |
field_rules JSON array, mandatory | The details of the fields and their values based on which you want to score the records. score - integer - the score you want to assign criteria - JSON object - the group that contains the field's API names, values and comparators, and the group operator(and, or). |
signal_rules JSON array, optional | The details of the various signals raised through integrations and insights, and their scores. score - integer - the score you want to assign signal - JSON object - the namespace and ID of the signal you want to associate with this scoring rule. Refer to the Get Configured Signals API to get these details. |
Update Scoring Rules
Request URL: {api-domain}/crm/v4/settings/automation/scoring_rules/{scoring_rule_ID} or
{api-domain}/crm/v4/settings/automation/scoring_rules (with rule_id in the input body)
Request Method: PUT
Scope: ZohoCRM.settings.scoring_rules.ALL/UPDATE
Supported Modules: Leads, Contacts, Accounts, Deals, and custom
What can you update through this API?
- Name, description, and score
- Add field and signal rules
- Update or delete field or signal rules
To delete a field or signal rule, include the key _delete with the ID of the rule and the signal, respectively.
Here is an example to delete the email insight bounce signal rule we configured earlier. We have also added another criteria for the field rule.
{ "scoring_rules":[ { "name":"Rule 8", "id":"3652397000010466004", "description":"Updated rule", "field_rules": [ //new field rule { "score": 5, "criteria": { "group_operator": "OR", "group": [ { "field": { "api_name": "Position" }, "comparator": "equal", "value": "Regional Manager" }, { "field": { "api_name": "Position" }, "comparator": "equal", "value": "Reviewer" } ] } } ], "signal_rules": [ //to delete the email insight bounce signal rule { "score": -5, "id": "3652397000010466007", "_delete":null } ] } ] } |
Delete Scoring Rules
Request URL: {api-domain}/crm/v4/settings/automation/scoring_rules/{scoring_rule_ID} or
{api-domain}/crm/v4/settings/automation/scoring_rules?ids=id1,id2..
Request Method: DELETE
Scope: ZohoCRM.settings.scoring_rules.ALL/DELETE
Supported Modules: Leads, Contacts, Accounts, Deals, and custom
Execute Scoring Rule
After creating a scoring rule, you have to execute it to apply the rule to the matching records. The Execute Scoring Rules API allows you to execute the scoring rules by their IDs or the layout ID.
Request URL: {api-domain}/crm/v3/{module_api_name}/actions/run_scoring_rules
Request Method: PUT
Scope: ZohoCRM.settings.scoring_rules.ALL/UPDATE
Supported Modules: Leads, Contacts, Accounts, Deals, and custom
To execute scoring rules by their IDs
Note that all the scoring rules must be for the same module. You can execute up to 5 rules.
Sample Input
{ "scoring_rules" : [ "3652397000010466004", "3652397000006074001" ] } |
To execute scoring rules in a layout by the layout ID
Sample Input
{ "layout" : { "id" :"3652397000000091055" } } |
We hope you found this post useful. Next week, we will discuss cloning, activating/deactivating a scoring rule, and getting the score of a record from a module.
Write to us at support@zohocrm.com if you have any questions.
Cheers!
Previous Post: Email the contact roles of a deal using Functions
Access your files securely from anywhere
Zoho FSM Video Tutorials
Centralize Knowledge. Transform Learning.
All-in-one knowledge management and training platform for your employees and customers.
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
Shylaja S
Sticky Posts
Announcing the new SKILL.md for Zoho CRM and the updated OAS repository!
We are introducing a new zoho-crm skill to make working with Zoho CRM Developer tools (like APIs, functions, widgets, client scripts, queries etc) easier and faster, with the help of AI in your preferred AI harness like Claude Code, Codex, Cursor, VSCodeKaizen #256 - Build an Arrival Readiness Web Tab in Zoho CRM
Hi everyone! Welcome back to the Kaizen series! In the post, we discuss a use case in hospitality industry: how an Arrival Readiness web tab widget can be used to let reception staff identify and resolve issues before arrival of guests. Use case In theKaizen #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 thisKaizen #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
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Billing 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
Cliq iOS can't see shared screen
Hello, I had this morning a video call with a colleague. She is using Cliq Desktop MacOS and wanted to share her screen with me. I'm on iPad. I noticed, while she shared her screen, I could only see her video, but not the shared screen... Does Cliq iOS is able to display shared screen, or is it somewhere else to be found ? RegardsIntroducing Smart Fields in Zoho Forms
Hello form builders! We are excited to introduce Smart Fields in Zoho Forms - a faster way to add calculations to your forms without writing formulas. Instead of creating multiple fields and configuring complex calculations yourself, you can now dragCheckbox not displaying correctly in subform
Greetings: I have shared my app (wv) with support. I am having problems with a checkbox field not displaying correctly in a subform. The main form is called volunteers and the subform is called volunteers_subform. The field in question is called roles. When you access the subform by itself the checkbox lookup displays as checkboxes. But when you view it in the main volunteers form, it displays as a multi-select dropdown instead. I have attached jpegs showing the difference. Any thoughts?Unbundle feature for composite items
We receive composite items from our vendors and sell them either individually or create other composite items out of them. So, there is a lot of bundling and unbundling involved with our composite items. Previously, this feature was supported in formThe reason I switched away from Zoho Notebook
My main reason for switching to Zoho was driven by three core principles: moving away from US-based products, keeping my data within India as much as possible, and supporting Indian companies. With that intent, I’ve been actively de-Googling my digitalLookups and Custom Modules
I created a Custom Module that I'm calling "Item Purchasing Group". This module will store information for groups of Items that must be purchased together (including minimum overall quantities and/or values, etc.). This will have a one-to-many relationshipValid characters for use in email addresses using Zoho's apps/APIs
We have found an issue with the + sign character in zoho subs - we are allowed to create a customer with an email address that has a plus sign but the API doesn't allow the + so the billing portal is not created. We are going to prevent users from usingExpand Zoho Analytics Spatial Capabitlities
Dear Analytics team Thanks for the great product - I'm a big fan on Analytics and the monthly release highlights is one of my favourite emails to receive. I'd like to request expansion and improvement of Zoho Analytics spatial data capabilities, namely:Automate customer follow-ups with Sequences in Bigin
Greetings, We hope you're all doing well! We're happy to announce a new feature that we've added to Bigin. Following up with every lead at the right time can be challenging, especially when your team is managing multiple conversations across emails, calls,Dashboards for Customers
Is it possible to build dashboards for each customers in the community for their tickets?Displaying only unread tickets in ticket view
Hello, I was wondering if someone might be able to help me with this one. We use filters to display our ticket list, typically using a saved filter which displays the tickets which are overdue or due today. What I'd really like is another filter thatAdding Custom Status Options in Work Order Action Menu
Hello FSM Team, We would like to inquire if it is possible to add more custom options in the Work Order action/status dropdown (e.g., Cancel, Terminate, Non-Billable, Void, etc.). Currently, the available options are limited, and we are unable to customizeCan we have an automated TDS Receivable Recon with Form 26AS of Income Tax Portal ?
Can we have an automated TDS Receivable Recon with Form 26AS of Income Tax Portal ?Tag Limi?
is there any way to create more than 20 tags?prefill_data for Creator + Merge & Sign
Hello, Is there an option to use prefill_data for signer fields from creator? I see the option for CRM but it will not work with creator? I have tried passing the value in the signer data, and that also does not work. Alternatively, is there a way toDelug script
I have been looking at auto-update a amount (home currency) field from another module. Zoho native multicurrency was used in the other module (we have 4 here). Custom script was input with no error, but the field was not updated on trigger. Script asCan I Build a Gaming Website Using Zoho? Need a Quick Roadmap
Hi Dear Members, I want to create a gaming website using Zoho. Is it possible? My goal is to build a sleek, unique, easy-to-navigate, and fast-loading website for a gaming project. I want the site to look professional, user-friendly, and optimized forRemove Due Date from Statements
Is it possible to remove the Due Date on the Invoice transation line on statements? I have figured work arounds to get the Invoice detail on the Statement but cannot work out haw to simplify the stament by removing the "- due on xx/xx/2026" - it reallyWhat Should an Agent-Native Project Workspace Look Like
AI is moving beyond assistants that simply answer questions. With tools like MCP, agents can now interact directly with project data and perform actions. That makes me wonder: what should an agent-native project workspace actually look like? For me, itunable to join meeting due to speaker issue
unable to join meeting due to speaker issueHow to add formatting in zoho.cliq.postToUser(...) message?
In a CRM Deluge function, I'm trying to use the message formatting guidelines given here: https://www.zoho.com/deluge/help/cliq/posting-to-zoho-cliq.html#message-formats My message is: message: #Title text. The result in Cliq is: #Title text. (no largeMarketing Tip #50: Sell digital products and use them to grow your store
Physical products need packaging, shipping, and stock management. Digital products need none of that. Once created, they can be sold an unlimited number of times, delivered instantly, and never go out of stock. What counts as a digital product? A digitalTurn off Mobile Optimize
Hello is it possible to stop the automatic mobile optimization of my site as it looks much better on a mobile in full site format rather than mobile format. ThanksHow to select from pricebook when creating a salesorder or quote
I am creating a sales order and when selecting the Products I do not see any where to select from pricebooks. How do i associate this to my orders?API - Available Stock Definitions
Okay, Zoho team... your copywriters fell down on the job for this one :) I think these warrant a bit more explanation as to what they include and what they don't.Cross-application Deluge calls fail when application link name starts with a number
I encountered an issue when calling a custom function in another Zoho Creator application within the same account. The target application’s URL/application link name began with a number, similar to: 27_example_application The following cross-applicationTransformez vos webinaires en opérations automatisées
Organiser un webinaire, c’est bien plus que passer en direct. Il faut gérer les inscriptions, suivre les participants, envoyer les enregistrements, mettre à jour le CRM… et s’assurer que chaque étape se déroule au bon moment. L’automatisation des workflowsMarketing Tip #1: Optimize item titles for SEO
Your item title is the first thing both Google and shoppers notice. Instead of a generic “Leather Bag,” go for something detailed like “Handcrafted Leather Laptop Bag – Durable & Stylish.” This helps your items rank better in search results and instantlyHow can I filter inactive/disable agent tickets?
Hello, We have an user-agent that left the company and we inactive/disabled his agent. So, now I can no longer filter or search tickets that he is the current owner, or even create a rule to reassign tickets to another person when the ticket is reopen.How do i move multiple tickets to a different department?
Hello, i have several tickets that have been assigned to the wrong department. I am talking about hundreds of automatically generated ones that come from a separate system. How can i select them all at once to move them to another department in one go? I can select them in "unsassigned open tickets view" but i can't find a "move to another department" option. I also can't seem to assign multiple tickets to the same agent in that same view. Could somebody advice?Add Reauthentication Option for Zoho Bug Tracker Integration in Zoho Desk
Hello Zoho Desk Team, We hope you're doing well. We would like to request an enhancement to the Zoho Bug Tracker integration within Zoho Desk. Current Limitation: At the moment, there is no option to reauthenticate the Zoho Bug Tracker integration inCreate Package From A Picklist
Dear Zoho, Can it be made possible to create a package from a picklist? The reason our company makes a picklist is for that to become a package Our sales orders have 600-1000 items I hope that makes it clear that it's hard to delete 990 items when weMigrating from Zoho Checkout to Zoho Billing
I have an active Zoho Checkout account where I'm charging customers for subscriptions. Now I'm looking to upgrade and only use Zoho BIlling, in which my account in on read only mode at the moment. I can see is also tracking the customers and its payments.API - Bank Accounts | Reconciliation Discrepancy
Unless I'm reading it wrong, the documentation for the Bank Reconciliations API is inconsistent with itself. https://www.zoho.com/books/api/v3/bank-accounts/#create-a-bank-reconciliation The text definition says that the transaction_id should be a string,another little issue
So to get over showing prices with VAT we used the price lists and made the prices inclusive. The problem is now on the items it wants to show the orginal retail value which makes no sense. Ideas pleaseHandle Leading Zeros in a Number Field
Hi, If I use a Number Field, set with Min 7 Digits and Max 7 Digits, and enter 0000001, it will result in 1 and an error as it removes the leading zeros, the same with entering 0012340 will result in 12340 and error. So I have to use a Text Field andcan't access zoho account
I can't log in to my zoho account, can you help meHTML PDF Templates / Build From Scratch option not visible for Custom Modules
Hi everyone, I am working with Zoho Books Custom Modules and trying to create a custom 4x4 package label PDF template using HTML/CSS. According to the official Zoho Books documentation for HTML PDF Templates, there should be an option like: Settings →Virtual Option for Fields
Hi, I would like to be able to choose another option other than Read-Only or Disabled, such as Virtual. And with Virtual, the field is shown on the form and avilable in rules, but NOT saved to the Database. A use case is having multiple Large Lists ofPrefix & Suffix on Single Line, Number, etc.
Hi, I would like to have the same Prefix and Suffix that was added to the Unique ID on Text and Number Fields. Use case could be as basic as temperature, as per another Idea I have to use Single Line (Text) for a number that might have leading zeros today,Next Page