Kaizen #69 - Scoring Rules[Part 2]

Hello everyone!

Welcome back to this week's Kaizen post!

In continuation to our previous post, this week we will discuss activating/deactivating a scoring rule, cloning, and getting the score of a record from a module.

Activating/deactivating a scoring rule

Use this API to activate or deactivate an existing scoring rule.

Request URL: {api-domain}/crm/v4/settings/automation/scoring_rules/{rule_id}/actions/activate

Use the Get Scoring Rules API to get the ID of the rule you want to activate or deactivate.

Request Method: PUT(to activate)/DELETE(to deactivate)

Scope: ZohoCRM.settings.scoring_rules.ALL (or) ZohoCRM.settings.scoring_rules.UPDATE(to activate a rule) (or)

ZohoCRM.settings.scoring_rules.DELETE(to deactivate a rule)

Supported Modules: Leads, Contacts, Accounts, Deals, and custom

Response of activating a scoring rule

Response of deactivating a scoring rule

Note

A scoring rule becomes active right after creation(if you give "active:true" while creation), but gets applied to the module's records only after you execute it.
After you deactivate a scoring rule, the scores of the records that were already calculated are retained, while new scores will not be calculated.

Cloning a scoring rule

You can clone a scoring rule instead of creating one from scratch through this API.

Request URL: {api-domain}/crm/v4/settings/automation/scoring_rules/{rule_id}/actions/clone

Use the Get Scoring Rules API to get the ID of the rule you want to clone from.

Request Method: POST

Scope: ZohoCRM.settings.scoring_rules.ALL/CREATE

Supported Modules: Leads, Contacts, Accounts, Deals, and custom

Response

Getting a record's score

After configuring a scoring rule and executing it, you can use this API to view the score of a record in a module.

Request URL: {api-domain}/crm/v4/{module_api_name}/{record_id}/Entity_Scores__s

Use the Get Records API to get the ID of the record.

Request Method: GET

Scope: ZohoCRM.settings.scoring_rules.ALL/GET

Supported Modules: Leads, Contacts, Accounts, Deals, and custom

Parameters: fields(mandatory)

Possible values: Positive_Score, Negative_Score, Touch_Point_Score, Touch_Point_Positive_Score, Touch_Point_Negative_Score, Score, Scoring_Rule, Entity

You can also use other field API names in the module.

Response

{

"data": [

{

"Entity": {

"module": {

"api_name": "Leads",

"id": "3652397000000002175"

"name": "scoring rules test",

"id": "3652397000010473001"

"Positive_Score": 9,

"Touch_Point_Score": -1,

"Score": 6,

"Negative_Score": -2,

"Touch_Point_Negative_Score": -10,

"Scoring_Rule": {

"name": null,

"id": "3652397000006074001"

"id": "3652397000010473011",

"Touch_Point_Positive_Score": 9

}

"info": {

"per_page": 200,

"next_page_token": null,

"count": 1,

"page": 1,

"previous_page_token": null,

"page_token_expiry": null,

"more_records": false

}

Key	Description
Entity JSON object	The JSON object that gives the details of the module, name and ID of the record. This object is returned in the response only when you include the value Entity for the fields parameter.
Positive_Score integer	The positive score of the record based on the scoring rule. This value is returned in the response when you include "fields=Positive_Score" in the parameters
Touch_Point_Positive_Score integer	The total positive scores obtained from all the touchpoints. This value is returned in the response when you include "fields=Touch_Point_Positive_Score" in the parameters.Touch_Point_Negative_Score integer
Touch_Point_Negative_Score integer	The total negative scores obtained from all the touchpoints. This value is returned in the response when you include "fields=Touch_Point_Negative_Score" in the parameters.
Negative_Score integer	The negative score of the record based on the scoring rule. This is returned for "fields=Negative_Score".
Touch_Point_Score integer	The difference between positive and negative touchpoint scores. This is returned for "fields=Touch_Point_Score".
Score integer	The overall score of the record. This is returned for "fields=Score".
Scoring_Rule JSON object	The API name and ID of the scoring rule that was applied on the record. This is returned for "fields=Scoring_Rule".

Note that for modules other than Leads and Contacts, the touchpoint scores will always be null.

We hope you found this post useful.

Get in touch with us at support@zohocrm.com if you have any questions, or let us know in the comments.

We will see you next week with another interesting post.

Cheers!

Access your files securely from anywhere

Zoho Developer Community

New to Zoho LandingPage?

Access Zoho LandingPage

Zoho LandingPage Resources

New to Zoho Survey?

Access Zoho Survey

Latest Feature Updates

Explore our Pricing & Plans

Zoho Survey Resources

Android Mobile Surveys

Insurvey Blogs

Insight Blogs

Tips & Tricks

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho CRM Plus?

Deliver unforgettable customer experiences

ACCESS ZOHO CRM PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

New to Zoho Marketing Plus?

Everything you need to run your marketing

ACCESS ZOHO MARKETING PLUS

New to Bigin?

Signup Now

Access Bigin

Latest Feature Updates

Zoho Desk Resources

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

Tout forum

France ZUGs

Zoho SalesIQ Resources

Topic Participants
Shylaja S

Sticky Posts
Kaizen#162 : Add Tags and Open Pre-filled Email Drafts via Client Scripts
Hello everyone! Welcome to another informative Kaizen post. In this post, let us see how to accomplish the following using Client Script. 1. How to auto-tag a record based on field update? 2. How to Open a pre-filled email draft This post will provide
Client Script | Update - Introducing Commands in Client Script!
Have you ever wished you could trigger Client Script from contexts other than just the supported pages and events? Have you ever wanted to leverage the advantage of Client Script at your finger tip? Discover the power of Client Script - Commands! Commands
Extension Pointers - JS SDK series #4: Managing data from a widget using ZOHO.CRM.HTTP
Handling and managing the data between two applications is a major factor for an efficient business. There are a variety of ways to handle data between Zoho CRM and other third-party applications. You can use deluge CRM tasks, create connectors, use API
Kaizen #152 - Client Script Support for the new Canvas Record Forms
Hello everyone! Have you ever wanted to trigger actions on click of a canvas button, icon, or text mandatory forms in Create/Edit and Clone Pages? Have you ever wanted to control how elements behave on the new Canvas Record Forms? This can be achieved
Extension pointers for integrating Zoho CRM with Zoho products #8: Upload and manage Zoho Workdrive folders and files from within Zoho CRM
Keeping records on your customers and business prospects is essential for tracking data, conducting follow-ups, and running a business smoothly. When you use two separate applications, and store relevant data in each, checking and tracking data becomes