Your use case. Our milestone. The 200th post in our "Kaizen Series: Continuous Improvement for Developer Experience" is coming up. Share Now

X
Skip to product menu
close
  • Recent Launches
    Press Space or Enter to display list of options
EXPLORE ALL PRODUCTS

Recent Launches

New

Easy domain registration, transfer, and secured DNS management.

Try now
New

Payroll software with automated tax payments and filing.

Try now
New

Low-code IoT platform and solutions for connected businesses.

Try now
New

Business formation service to launch and grow your businesses.

Try now
New

Unified payment solution built for all businesses.

Try now
New

Comprehensive email security and archiving for every business.

Try now
Suites

Cloud-based qualitative data analysis tool.

Try now
New

Online community platform for individuals and businesses to grow their network and brand.

Try now
New

Modern retail POS to sell better, manage your entire business, and join the digital revolution.

Try now
SuitesNew

Unified project management platform for intelligent, data-driven work.

Try now
Suites

Unified platform for customer service and support teams.

Try now

Sales

CRM

Comprehensive CRM platform for customer-facing teams.

CRM
Voice

Cloud Contact Center Software for businesses.

Voice
Sign

Digital signature app for businesses.

Sign
Forms

Build online forms for every business need.

Forms
Bigin

Simple CRM for small businesses moving from spreadsheets.

Bigin
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
Bookings

Appointment scheduling app for consultations with customers.

Bookings
RouteIQ

Comprehensive sales map visualization and optimal route planning solution.

RouteIQ
Thrive

Complete loyalty and affiliate management platform.

Thrive
Suites
CRM Plus

Unified platform to deliver top-notch customer experience.

CRM Plus

Marketing

Campaigns

Create, send, and track targeted email campaigns that drive sales.

Campaigns
Voice

Cloud Contact Center Software for businesses.

Voice
Sign

Digital signature app for businesses.

Sign
Forms

Build online forms for every business need.

Forms
Social

All-in-one social media management software.

Social
Survey

Design surveys to reach and interact with your audience.

Survey
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
Sites

Online website builder with extensive customisation options.

Sites
Backstage

End-to-end event management software.

Backstage
PageSense

Website conversion optimization and personalisation platform.

PageSense
Marketing Automation

All-in-one marketing automation software.

Marketing Automation
LandingPage

Smart landing page builder to increase conversion rates

LandingPage
Webinar

Webinar platform for webcasting online webinars.

Webinar
NEW
LeadChain

Sync, manage, and convert leads across channels seamlessly.

LeadChain
NEW
Domains

Easy domain registration, transfer, and secured DNS management.

Domains
NEW
CommunitySpaces

Online community platform for individuals and businesses to grow their network and brand.

CommunitySpaces
Thrive

Complete loyalty and affiliate management platform.

Thrive
Publish

Manage all your local business listings on a single platform.

Publish
Suites
Marketing Plus

Unified marketing platform for marketing teams.

Marketing Plus

Commerce and POS

Commerce

eCommerce platform to manage and market your online store.

Commerce

Service

Desk

Helpdesk software to deliver great customer support.

Desk
Assist

Remote support and unattended remote access software.

Assist
Voice

Cloud Contact Center Software for businesses.

Voice
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
Bookings

Appointment scheduling app for consultations with customers.

Bookings
FSM

End-to-end field service management platform for service businesses.

FSM
Lens

Interactive remote assistance software with augmented reality.

Lens
Solo

The all-in-one toolkit for solopreneurs.

Solo
Suites
Service Plus

Unified platform for customer service and support teams.

Service Plus

Finance

Books

Powerful accounting platform for growing businesses.

Books
Expense

Effortless expense reporting platform.

Expense
Sign

Digital signature app for businesses.

Sign
Inventory

Powerful stock management and inventory control software.

Inventory
FREE
Invoice

100% Free invoicing solution.

Invoice
Billing

End-to-end billing solution for your business.

Billing
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
Commerce

eCommerce platform to manage and market your online store.

Commerce
Checkout

Collect payments online with custom branded pages.

Checkout
Practice

Practice management software for accounting firms.

Practice
Solo

The all-in-one toolkit for solopreneurs.

Solo
NEW
Payments

Unified payment solution built for all businesses.

Payments
Suites
Finance Plus

All-in-one suite to manage your operations and finances.

Finance Plus

Email, Storage, and Collaboration

Mail

Secure email service for teams of all sizes.

Mail
Voice

Cloud Contact Center Software for businesses.

Voice
Sign

Digital signature app for businesses.

Sign
WorkDrive

Online file management for teams.

WorkDrive
Bookings

Appointment scheduling app for consultations with customers.

Bookings
Cliq

Stay in touch with teams no matter where you are.

Cliq
Notebook

Beautiful home for all your notes.

Notebook
Meeting

Online meeting software for all your video conferencing & webinar needs.

Meeting
Connect

Employee experience platform to communicate, engage, and build positive employee relations.

Connect
Learn

Knowledge and learning management platform.

Learn
Office Integrator

Built in document editors for web apps.

Office Integrator
Writer

Word processor for focused writing and discussions.

Writer
TeamInbox

Shared inboxes for teams.

TeamInbox
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
Show

Create, edit, and share slides with a sleek presentation app.

Show
Tables

Work management tool to connect people, processes, and information.

Tables
Sheet

Spreadsheet software for collaborative teams.

Sheet
Office Suite

Powerful collaborative work platform for teams.

Office Suite
Calendar

Online business calendar to manage events and schedule appointments.

Calendar
ToDo

Collaborative task management for individuals and teams.

ToDo
FREE
PDF Editor

Collaborative online PDF editing tool.

PDF Editor
Suites
Workplace

Application suite built to improve team productivity and collaboration.

Workplace

Human Resources

Expense

Effortless expense reporting platform.

Expense
Recruit

Intuitive recruiting platform built to provide hiring solutions.

Recruit
People

Organize, automate, and simplify your HR processes.

People
Sign

Digital signature app for businesses.

Sign
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
Shifts

Employee scheduling and time tracking app.

Shifts
Workerly

Manage temporary staffing with an employee scheduling solution.

Workerly
Suites
People Plus

Comprehensive HR platform for seamless employee experiences.

People Plus

Security and IT Management

Creator

Build custom apps to simplify business processes.

Creator
Assist

Remote support and unattended remote access software.

Assist
Vault

Online password manager for teams.

Vault
Directory

Workforce identity and access management solution for cloud businesses.

Directory
Lens

Interactive remote assistance software with augmented reality.

Lens
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
NEW
eProtect

Comprehensive email security and archiving for every business.

eProtect
FREE
OneAuth

Secure multi-factor authenticator (MFA) for all your online accounts.

OneAuth
Toolkit

Complete resource for any admin-related lookup queries.

Toolkit

BI and Analytics

Analytics

Modern self-service BI and analytics platform.

Analytics
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
NEW
IoT

Harnessing IoT analytics for real-time operational intelligence.

IoT
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI

Project Management

Projects

Manage, track, and collaborate on projects with teams.

Projects
Sprints

Planning and tracking tool for scrum teams.

Sprints
BugTracker

Automatic bug tracking software for managing bugs.

BugTracker
Solo

The all-in-one toolkit for solopreneurs.

Solo
Suites
Projects Plus

Unified project management platform for intelligent, data-driven work.

Projects Plus

Developer Platforms

Creator

Build custom apps to simplify business processes.

Creator
Flow

Automate business workflows by creating smart integrations.

Flow
Office Integrator

Built in document editors for web apps.

Office Integrator
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
Tables

Work management tool to connect people, processes, and information.

Tables
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
NEW
IoT

Build, deploy, and scale IoT solutions for connected businesses.

IoT
Apptics

Application analytics for all apps.

Apptics
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI

IoT

NEW
IoT

Low-code IoT platform and solutions for connected businesses.

IoT

Search Result

CRM Plus

Unified platform to deliver top-notch customer experience.

Try now
CRM Plus
Service Plus

Unified platform for customer service and support teams.

Try now
Service Plus
Finance Plus

All-in-one suite to manage your operations and finances.

Try now
Finance Plus
People Plus

Comprehensive HR platform for seamless employee experiences.

Try now
People Plus
Workplace

Application suite built to improve team productivity and collaboration.

Try now
Workplace
Marketing Plus

Unified marketing platform for marketing teams.

Try now
Marketing Plus
Projects Plus

Unified project management platform for intelligent, data-driven work.

Try now
Projects Plus
All-in-one suite

Zoho One

The Operating System for Business

Run your entire business on Zoho with our unified cloud software, designed to help you break down silos between departments and increase organizational efficiency.

TRY ZOHO ONE
Zoho Marketplace

With over 2000 ready-to-use extensions across 40+ categories, connect your favorite business tools with the Zoho products you already use.

EXPLORE MARKETPLACE
Skip to main content

Create Scoring Rules

The Create Scoring Rules API allows you to define scoring rules that can be applied to specific layouts or globally across all layouts within your Zoho CRM organization. Scoring rules can be constructed using either field rules, signal rules, or a combination of both. Refer to Multiple Scoring Rules to learn more about scoring rules.

The following table outlines the availability and limitations of scoring rules based on different editions of Zoho CRM.

Supported Editions and Limits:

EditionMultiple Layout SupportActive Rules per ModuleTotal Rules per ModuleNumber of Criteria per Rule
Standard (S)NO1110
ZohoOne Standard (Y)NO1110
Professional (P, R)NO1120
Developer (D)YES - 2 layouts15305
Enterprise (E, A)YES - 4 layouts255030
ZohoOne Enterprise (Z)YES - 4 layouts255030
CrmPlus (C)YES - 7 layouts408050
Ultimate (U)YES - 7 layouts408050

Purpose

To create a scoring rule for a module in the Zoho CRM organization.

Note

Only Leads, Contacts, and other people-based modules support signal rules. Non-people modules such as Deals and Accounts do not support signal rules.

Request Details

Request URL

{api-domain}/crm/{version}/settings/automation/scoring_rules

Supported modules

Leads, Accounts, Contacts, Deals and Custom

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.settings.scoring_rules.ALL
(or)
ZohoCRM.settings.scoring_rules.{operation_type}

Possible operation types

ALL - Full access to scoring rules
CREATE - Create scoring rules

Sample Request

Copied

Input JSON

  • scoring_rulesJSON array, mandatory

    An array containing the scoring rule objects.

  • namestring, mandatory

    Represents the unique name of the scoring rule. The maximum possible length for this field is 25 characters.

  • moduleJSON object, mandatory

    Represents the module for which the scoring rule is defined. This object must include the ID and the API name of the module.

  • descriptionstring, optional

    Represents the description of the scoring rule. The maximum possible length for this field is 500 characters.

  • layoutJSON object, optional

    Represents the layout the scoring rule is associated with. This object must include the ID and the API name of the layout.

  • activeBoolean, optional

    Indicates whether the scoring rule is active. 
    Possible values :
    true - The rule is active. This is the default value.
    false - The rule is inactive.

  • field_rulesJSON array, optional if signal_rules is specified

    An array of field rule objects associated with the scoring rule. Each field rule must include:

    • scorenumber, mandatory

      Represents the score assigned for the specific rule. The value of this keys ranges from -100 to 100.

    • criteriaJSON object, mandatory

      Represents the criteria details, including:

      • group_operatorstring, mandatory

        The logical operator used to combine criteria. Possible values are and or or.

      • groupJSON array, mandatory

        An array of criteria objects that define the conditions for scoring. Each criterion must include:

        • fieldJSON object, mandatory

          Specify the field being evaluated.

        • comparator stringstring, mandatory

          The comparison operator. The supported operators are equals, starts_with, in, not_equal, greater_equal, greater_than, less_equal, less_than and between.

        • valuestring, mandatory

          The value to compare the field value against.

  • signal_rulesJSON array, optional if field_rules is specified

    An array of signal rule objects defined for this scoring rule. Each signal rule must include:

    • scorenumber, mandatory

      The score assigned to this signal rule. The value of this keys ranges from -100 to 100.

    • signalJSON object, mandatory

      Represents the signal details. You can get the signal details using the Signals API.

      • namespacestring, mandatory

        The namespace of the signal.

      • idstring, mandatory

        The unique identifier for the signal.

  • custom_fieldsJSON array, optional

    An array of custom field objects that allow users to map scores to existing fields. Each custom field includes:

    • field_labelstring, mandatory

      The label for the custom field as it will appear in the user interface.

    • reference_fieldJSON object, mandatory

      To map the custom field to a specific score.

      • api_namestring, mandatory

        The API name of the score that you want to map. The possible values are Positive_Score, Negative_Score, Touch_Point_Score, Touch_Point_Positive_Score, Touch_Point_Negative_Score and Score.

Note

At least one of either field_rules or signal_rules must be specified.

Custom Fields Limit for Scoring Rules

The following table outlines the maximum number of custom fields that can be created for scoring rules, based on the edition of Zoho CRM you are using. The maximum number of fields you can add for one scoring rule is six, irrespective of the edition. Please note that the custom fields must remain within the integer custom fields limit of the respective module. 

EditionLimit   
Standard (S)6
Zoho One Standard (Y)6
Professional (P, R)6
Developer (D)6
Enterprise (A, E)30
Zoho One Enterprise (Z)30
CRM Plus (C)30
Ultimate (U)30

Note

Any custom field created while creating a scoring rule will be deleted when the scoring rule itself is deleted.

Sample Input

Copied

Possible Errors

  • INVALID_REQUEST_METHODHTTP 400

    The request method is incorrect.
    Resolution: Use the HTTP POST method to make this API call. Any other request method will result in this error.

  • INVALID_DATAHTTP 400

    You have specified an invalid or unsupported module, or an invalid layout.
    Resolution: Specify valid module and layout details.

  • INVALID_DATAHTTP 400

    You have either specified a rule name exceeding 25 characters or description exceeding 500 characters.
    Resolution: Please specify the name and description within their respective limits of 25 characters and 500 characters.

  • MANDATORY_NOT_FOUNDHTTP 400

    You have not specified a mandatory field in the input.
    Resolution: Please specify all mandatory fields. Refer to the input JSON section to know more.

  • EXPECTED_FIELD_MISSINGHTTP 400

    You have not specified fields rule or signal rule.
    Resolution: Specify the field rules and/or signal rules to create the scoring rule.

  • DUPLICATE_DATAHTTP 400

    A scoring rule with the specified criteria or the same name already exists
    Resolution: Specify a different criterion or name for the rule.

  • ALREADY_USEDHTTP 400

    The specified criteria is already given in the same rule under different index.
    Resolution: Please specify a different criteria.

  • NOT_SUPPORTEDHTTP 400

    You have specified Signal rules for non-people module. Signal rules are not supported for non-people modules.
    Resolution: Use field rules for the specified module.

  • INVALID_DATAHTTP 400

    You have specified an invalid value for the score key. Specify a valid value for the key.
    Resolution: Please refer to input JSON section for more details.

  • ACTIVE_STATE_LIMIT_EXCEEDEDHTTP 400

    You have exceeded the number of active rules possible for your account.
    Resolution: Limit the number of active rules within the permissible limit. Refer to the feature limits table at the beginning of this page for more details.

  • LIMIT_EXCEEDEDHTTP 400

    You have already created the maximum number of scoring rules possible.
    Resolution: Limit the number of rules within the maximum possible limit. Refer to the feature limits table at the beginning of this page for more details.

  • FEATURE_NOT_SUPPORTEDHTTP 400

    You are trying to create multiple scoring rules for an unsupported edition.
    Resolution: Contact system administrator.

  • NOT_SUPPORTEDHTTP 400

    Given field is not available with the given layout.
    Resolution: Specify fields available in the given layout.

  • NOT_SUPPORTEDHTTP 400

    Layout or score fields is specified in the criteria.
    Resolution: Specify valid fields in the criteria.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    The access token you have used to make this API call does not have the required scope.
    Resolution: Generate a new access token with the required scopes for this API. Refer to the Scope section at the beginning of this page for the list of required scopes.

  • NO_PERMISSIONHTTP 403

    You do not have permission to create scoring rules.
    Resolution: The user does not have permission to create scoring rules. Contact your system administrator.

  • INVALID_URL_PATTERNHTTP 404

    The request URL is incorrect.
    Resolution: Specify a valid request URL. Refer to the request URL section at the beginning of this page for more details.

  • INTERNAL_ERRORHTTP 500

    Unexpected and unhandled exception in the server. 
    Resolution: Contact the support team at support@zohocrm.com.

Sample Response

Copied