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
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
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 achievedKaizen #142: How to Navigate to Another Page in Zoho CRM using Client Script
Hello everyone! Welcome back to another exciting Kaizen post. In this post, let us see how you can you navigate to different Pages using Client Script. In this Kaizen post, Need to Navigate to different Pages Client Script ZDKs related to navigation A.Kaizen #210 - Answering your Questions | Event Management System using ZDK CLI
Hello Everyone, Welcome back to yet another post in the Kaizen Series! As you already may know, for the Kaizen #200 milestone, we asked for your feedback and many of you suggested topics for us to discuss. We have been writing on these topics over theKaizen #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.
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
Kaizen #214 - Workflow APIs - Part 2
Welcome back to another week of Kaizen! Last week, we discussed how Zylker Cloud Services used the Workflow APIs to discover and audit all the automations in their CRM, listing every workflow, checking triggers, and understanding their automation limits.Playback and Management Enhancements for Zoho Quartz Recordings
Hello Zoho Team, We hope you're all doing well. We would like to submit a feature request related to Zoho Quartz, the tool used to record and share browser sessions with Zoho Support. 🎯 Current Functionality As of now, Zoho Quartz allows users to recordImplementing a Self-Invoicing/Vendor Portal in Zoho Creator
Hello Zoho Community / Creator Experts, We would like to build a Self-Invoicing Portal (Vendor Portal) in Zoho Creator for our external contractors. Our goal is to allow approved contractors to log in, submit their invoice details (hours worked, projectZoho CRM Community Digest - September P1 | 2025
Hello Everyone! September's Here! Before we jump into product updates, and community highlights, here's a quick spotlight! Zoho has launched a Professional Sales Rep Certification course on Coursera, tailored for sales professionals to strengthen theirUpload my theme.
Hello. I would like to upload my own theme, this one: https://themeforest.net/item/panagea-travel-and-tours-listings-template/21957086 Is it compatible and where I upload it? If not I will hire a developer, what do I have to ask when I search for one?Explore the Redesigned Quotes Module in Zoho Billing
Dear users, We’re excited to introduce a refreshed look for the Quotes details page in Zoho Billing! This update brings you a more efficient user interface experience without changing your existing workflow. We've enhanced layouts with organized tabs,Product Updates in Zoho Workplace applications | September 2025
Hello Workplace Community, Let’s take a look at the new features and enhancements that went live across all Workplace applications this September. Zoho Mail Attach email as EML file in Compose Effortlessly attach emails as EML file in Compose by simplyVehicle Tracking
we have GPS devices that installed on our vehicles, and we would like to know if it's possible to get vehicle live location data from the GPS device To Zoho Creator App. Thank You🤝 Rencontres, partage et inspiration au Zoho Community Meetup de novembre
Chers utilisateurs, Bonne nouvelle 🎉 : notre Meetup Zoho Community approche, et nous serions ravis de vous y voir ! 📍 Toulouse : le 25 novembre 📍 Lyon : le 27 novembre (🎯 Il ne reste que quelques places !) Que vous soyez débutant ou utilisateur avancé,Need Help Mapping GST Registration Number Field Between Zoho Books & Zoho CRM + Slow Sync Issues
am facing an issue with field mapping between Zoho Books and Zoho CRM. I want to map the GST Registration Number field from the Customer module in Zoho Books to a custom GST field inside the Accounts module in Zoho CRM. However, I am getting a warningNotification received when self-assigning tickets
When I assign tickets in Zoho Desk the relevant agent gets a notification email. When assigning myself a ticket in Zoho Desk, I get a notification email. Now, as I am the person who assigned the ticket to myself, getting a notification in this regardNouveauté dans Zoho Writer - Création de documents et de modèles assistée par l'IA
Zia, l’assistant IA de Zoho Writer, soutient les utilisateurs dans l’amélioration de leur écriture et la création de contenus : correction orthographique et grammaticale en temps réel, suggestions adaptées au contexte, détection du plagiat, révisionsSession Expired
I constantly get "Session Expired" and need to relogin or close and open the application again. This gets really frustrating during the day. Is this something that can be solved? This really makes me want to leave the app as it is no go to need to reopenIntegrate your Outlook/ Office 365 inbox with Zoho CRM via Graph API
Hello folks, In addition to the existing IMAP and POP options, you can now integrate your Outlook/Office 365 inbox with Zoho CRM via Graph API. Why did we add this option? Microsoft Graph API offers a single endpoint to access data from across Microsoft’sDisable Buttons for Users with Profiles without permission
Hey, I've noticed that users without permission of setting up things in the marketplace, can still see the icon: On a click, you see this: It would be way better, if they couldn't see this menu icon at all. (Aside from the fact that it completely misplacedLink to images
I have added images in pages. I would like to link those images with linked in URL so that they open in new window. There is an option of image -> link but I am not able to use the same to open URL in new window. Please check the attached image. Can youMapping a new Ticket in Zoho Desk to an Account or Deal in Zoho CRM manually
Is there any way for me to map an existing ticket in Zoho desk to an account or Deal within Zoho CRM? Sometimes people use different email to put in a ticket than the one that we have in the CRM, but it's still the same person. We would like to be ableZoho Analytics - Make text clickable in underlying data
Hi Community, I have a simple sales report based on a Invoice query table. I have included a link on to each invoice on the table and sent the Invoice number URL to the link. This works find in the query table, but when I click underlying data on theCredit Management: #5 Advanced Refund Policy
You're subscribed to a well-known SaaS design tool. You've used it to manage your team's projects, create marketing visuals, brochures, and so on. But your needs change over time. Your company may switch to another tool or hire an in-house designer whoExported Slide Image Lacks Portion of the Background Image
This does not always happen, but when I export (or "download") the rendered image of a slide, it sometimes lacks a portion of the background image. I created a sample slide deck to demonstrate it and shared it with the admins. It is also publicly availableHow to create a Zoho Mail extension similar to Outlook's OnSend add-in?
Hi, I want to create a Zoho Mail extension similar to Outlook’s OnSend add-in. The extension should: Let the user select headers and footers from a taskpane while composing an email. When the user clicks Send, the extension should: Automatically insertEffective Inbox Organization: Folders vs Tags in Zoho Mail?
I'm exploring the best ways to organize a busy inbox, especially when managing multiple clients or project using Zoho Mail. I’d love to know what works best for others: 1. Do you prefer **folders** (possibly with sub-folders) for each client or project?Piss poor service in Support in Domains and email
Srijith Narayanan B contacted me today. Very pleasant fellow. Just didn't want to tell him how bad your support service is. You help the person, but you leave before we can finish the next stage. Which causes a lot of frustration. It's been 8 days nowZoho Mail android app update: Block & reject future emails, Report phishing, Spam alerts, Suspicious URL detection
Hello everyone! In the most recent Zoho Mail Android app update, we have brought in support for the following features: Block & reject future emails Report Phishing Spam alerts in the mail details screen. Suspicious URL detection. Block & reject futureZohomail does not support additional fields in mailto links
Hello, I set up Zohomail as default composer in Firefox according to manual here: https://www.zoho.com/mail/help/defaultcomposer.html#alink2 Later, I wanted to use this functionality to answer in a Linux mailing list thread using mailto link: mailto:xxxxx@kernel.org?In-Reply-To=%3C727o0521-q24p-s0qq-66n0-sn436rpqqr1p@example.com%3E&Cc=xxxxx%example.org&Subject=Re%3A%20%5BPATCH%20v2%28%29Emails not being received from a particular domain
Cannot receive any emails sent from atco.com Domain is in the spam whitelist so should be no reason for it not to be coming through. Have filed a ticket and besides a generic response of we are looking at it - it seems there is no actual support workersEmail address for forwarding is not saving and there's no confirmation ema
Steps to reproduce: 1. Enter my forward email in the email forward section of the account 2. Click save 3. See a notification stating saved successfully 4. Refresh the page, no forward email is saved 5. No email confirmation received at the forwardingThis domain is not allowed to add in Zoho. Please contact support-as@zohocorp.com for further details
This is the error i keep getting when trying to use my Zoho Domain Mail. This domain is not allowed to add in Zoho. Please contact support-as@zohocorp.com for further details Find attached. I hope this can be resolved very quickly so i can go on and makeAuto CC - Moving Departments
We have Auto CC e-mail replies to your support mailbox enabled. We have two departments: Helpdesk (helpdesk@domain.com) Delivery (delivery@domain.com) If we create a Helpdesk ticket, and reply, replies are CC'd to helpdesk@domain.com (OK) We then moveunable to send message reason 554 5.1.8 Email outgoing blocked
unable to send message reason 554 5.1.8 Email outgoing blockedMailk got blocked / Inquiry About Email Sending Limits and Upgrade Options
Dear Zoho Support Team, My name is Kamr Elsayed I created this account to use for applying for vocational training in Germany. As part of this process, I send multiple emails to different companies. However, after sending only 8 emails today, I receivedSMTP email sending problem
Hello, I've sent emails before, but you haven't responded. Please respond. My work is being disrupted. I can't send emails via SMTP. Initially, there were no problems, but now I'm constantly receiving 550 bounce errors. I can't use the service I paidunblock my zoho mail account. outlines@zoho.com
please unblock my zoho mail account, outlines@zoho.comUnable to see free plan option
Hello Zoho Support Team, I hope you are doing well. I am trying to sign up for Zoho Mail, but I am unable to see the option for the free plan. Could you please guide me on how I can access or activate the free plan? Thank you for your assistance.Outgoing blocked: Unusual activity detected.
I just made payment for my Zohomail Today and have been debited so i will like to be Unblocked because this is what it says (Outgoing blocked: Unusual activity detected) Thank you i await your swift responsesHow to remove some users in zoho accounts
How to remove some users in Zoho accounts.Forwarder
Hi, I tried to add a forwarder from which emails are sent to my main zoho account email . However, it asks me for a code that should be received at the forwarder email, which is still not activated to send to my zoho emial account. So how can I get theForwarder
Hi, I tried to add a forwarder from which emails are sent to my main zoho account email . However, it asks me for a code that should be received at the forwarder email, which is still not activated to send to my zoho emial account. So how can I get theDKIM cannot be enabled for the domain as no verified default selector present
Hi Support Team, For Domain DKIM record trying to enable status. but showing error "DKIM cannot be enabled for the domain as no verified default selector present" So, please resolve the issue. Thank you.I can't log in to my account on Thunderbird
I've just had to rebuild my PC (calamitous mess from Microsoft with Win10/Win 11 'upgrade' - they confirmed I had to start with a new build). I have used Zoho mail for years via Mozilla Thunderbird, but now I've had to download the latest version of TBird,Next Page