Zoho: Scoring rules schemas

← Scoring rules operations · All schemas

Activate a scoring rule — response body

Field	Type	Presence	Description and constraints
$	object	Root	Scoring rule successfully activated Additional keys: not allowed
scoring_rules	array	Optional	Activation result for the scoring rule, containing the status and details of the activated rule. Maximum items: 1
scoring_rules[]	Model	Each item	Expand Clone a scoring rule — response body — scoring rules item

Referenced models: Clone a scoring rule — response body — scoring rules item

Clone a scoring rule — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Empty request body Additional keys: not allowed

Clone a scoring rule — response body

Field	Type	Presence	Description and constraints
$	object	Root	successful cloning of a rule Additional keys: not allowed
scoring_rules	array	Optional	Clone result for the scoring rule, containing the status and ID of the newly cloned rule. Maximum items: 1
scoring_rules[]	Model	Each item	Expand Clone a scoring rule — response body — scoring rules item

Referenced models: Clone a scoring rule — response body — scoring rules item

Clone a scoring rule — response body — scoring rules item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the per-item operation result for a Scoring Rule action, including status, code, and message. Additional keys: not allowed
code	string	Optional	Represents the result code for this per-item Scoring Rule operation. Maximum length: 255
details	Model	Optional	Expand Clone a scoring rule — response body — scoring rules item details
message	string	Optional	Response message for the scoring rule operation Maximum length: 255
status	string	Optional	Response status for the scoring rule operation Maximum length: 255

Referenced models: Clone a scoring rule — response body — scoring rules item details

Clone a scoring rule — response body — scoring rules item details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details returned in a successful Scoring Rule operation, including the affected rule ID and any unsaved custom fields. Additional keys: allowed
id	string	Optional	Represents the unique ID of the Scoring Rule affected by the operation. Maximum length: 25
unsaved_custom_fields	array	Optional	Represents an array of custom fields that could not be saved during the operation. Maximum items: 6
unsaved_custom_fields[]	Model	Each item	Expand Clone a scoring rule — response body — scoring rules item details unsaved custom fields item

Referenced models: Clone a scoring rule — response body — scoring rules item details unsaved custom fields item

Clone a scoring rule — response body — scoring rules item details unsaved custom fields item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details of a custom field that could not be saved during the operation. Additional keys: not allowed
field_label	string	Optional	Represents the display name of the custom field that could not be saved. Maximum length: 100

Deactivate a scoring rule — response body

Field	Type	Presence	Description and constraints
$	object	Root	Successful deactivation of a rule Additional keys: not allowed
scoring_rules	array	Optional	Deactivation result for the scoring rule, containing the status and details of the deactivated rule. Maximum items: 1
scoring_rules[]	Model	Each item	Expand Clone a scoring rule — response body — scoring rules item

Referenced models: Clone a scoring rule — response body — scoring rules item

Delete a scoring rules by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root	successful deletion of a rule Additional keys: not allowed
scoring_rules	array	Optional	Deletion result for the scoring rule, containing the status and ID of the deleted rule. Maximum items: 1
scoring_rules[]	Model	Each item	Expand Clone a scoring rule — response body — scoring rules item

Referenced models: Clone a scoring rule — response body — scoring rules item

Get scoring rule by ID — response body — Scoring rule details

Field	Type	Presence	Description and constraints
$	object	Root	Scoring rule details Additional keys: not allowed
scoring_rules	array	Optional	Represents an array containing the Scoring Rule details returned for the get by ID operation. Maximum items: 1
scoring_rules[]	Model	Each item	Expand Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item

Referenced models: Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item

Scoring Rules — scoring Rules delete Scoring Rules — response body — All rules are deleted successfully

Field	Type	Presence	Description and constraints
$	object	Root	All rules are deleted successfully Additional keys: not allowed
scoring_rules	array	Optional	Deletion results for all requested scoring rules. Maximum items: 20
scoring_rules[]	Model	Each item	Expand Clone a scoring rule — response body — scoring rules item

Referenced models: Clone a scoring rule — response body — scoring rules item

Scoring Rules — scoring Rules delete Scoring Rules — response body — few ids are invalid and others rules are deleted

Field	Type	Presence	Description and constraints
$	object	Root	few ids are invalid and others rules are deleted. Additional keys: not allowed
scoring_rules	array	Optional	Mixed deletion results - includes success entries for deleted rules and error entries for invalid IDs. Maximum items: 20
scoring_rules[]	Model	Each item	Expand Clone a scoring rule — response body — scoring rules item

Referenced models: Clone a scoring rule — response body — scoring rules item

Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response body for the list Scoring Rules operation. Additional keys: not allowed
info	Model	Optional	Expand Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules info
scoring_rules	array	Optional	Represents an array of Scoring Rule summary objects returned in the list response. Maximum items: 300
scoring_rules[]	Model	Each item	Expand Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item

Referenced models: Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item, Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules info

Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules info

Field	Type	Presence	Description and constraints
$	object	Root	Nested schema for info Additional keys: not allowed
count	JSON	Optional
count (anyOf 1)	integer	Alternative	Total number of scoring rules returned in the current response page. Format: int32
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
more_records	boolean	Optional	Indicates whether additional scoring rules are available beyond the current page.
page	JSON	Optional
page (anyOf 1)	integer	Alternative	Current page number in the paginated response. Format: int32
page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
per_page	JSON	Optional
per_page (anyOf 1)	integer	Alternative	no of rules need to be fetched per_page Format: int32
per_page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the root element for defining a scoring rule, including layout, fields, custom fields, and scoring configurations. Additional keys: not allowed
active	boolean	Optional	Indicates whether the Scoring Rule is active (`true`) or inactive (`false`).
created_by	Model	Optional	Expand Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item created by
created_time	string	Optional	Scoring rule created time Maximum length: 255
custom_fields	JSON	Optional
custom_fields (anyOf 1)	array	Alternative	Represents the custom fields configured for this Scoring Rule to hold referenced scores. Maximum items: 6
custom_fields (anyOf 1)[]	Model	Each item	Expand Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item custom fields null item
custom_fields (anyOf 2)	null	Alternative	Represents the custom fields configured for this Scoring Rule to hold referenced scores. Maximum items: 6
custom_fields (anyOf 2)[]	Model	Each item	Expand Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item custom fields null item
description	JSON	Optional
description (anyOf 1)	string	Alternative	Represents the optional description of the Scoring Rule. This field is nullable. Maximum length: 500
description (anyOf 2)	null	Alternative	Represents the optional description of the Scoring Rule. This field is nullable. Maximum length: 500
field_rules	array	Optional	Module field based score configuration can be added here Maximum items: 50
field_rules[]	Model	Each item	Expand Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item field rules item
has_signal_rules	boolean	Optional	It defines whether the production scoring rule has any signal rules or not. Applicable only for Leads and Contacts modules rules in Sandbox environment.
id	string	Optional	Represents the unique ID of the Scoring Rule. Maximum length: 255
layout	Model	Optional	Expand Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item layout Layout info. If the rule should be created for all layouts, this field can be skipped or set value as null.
modified_by	Model	Optional	Expand Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item modified by Scoring rule modified by
modified_time	JSON	Optional
modified_time (anyOf 1)	string	Alternative	Represents the date and time when the Scoring Rule was last modified, in ISO 8601 format. This field is nullable. Maximum length: 255
modified_time (anyOf 2)	null	Alternative	Represents the date and time when the Scoring Rule was last modified, in ISO 8601 format. This field is nullable. Maximum length: 255
module	Model	Required within parent	Expand Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item module module info (Required)
name	string	Required within parent	Represents the unique name of the Scoring Rule. Maximum length: 25
signal_rules	JSON	Optional
signal_rules (anyOf 1)	array	Alternative	Touch points based score configurations; applicable only for Leads and Contacts modules Maximum items: 250
signal_rules (anyOf 1)[]	Model	Each item	Expand Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item signal rules null item
signal_rules (anyOf 2)	null	Alternative	Touch points based score configurations; applicable only for Leads and Contacts modules Maximum items: 250
signal_rules (anyOf 2)[]	Model	Each item	Expand Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item signal rules null item

Referenced models: Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item created by, Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item custom fields null item, Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item field rules item, Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item layout, Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item modified by, Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item module, Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item signal rules null item

Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item created by

Field	Type	Presence	Description and constraints
$	object	Root	Nested schema for created_by Additional keys: not allowed
id	string	Optional	Unique numeric ID of the user who created the scoring rule. Maximum length: 25
name	string	Optional	Full name of the user who created the scoring rule. Maximum length: 255
zuid	string	Optional	Zoho unique ID (ZUID) of the user who created the scoring rule. Maximum length: 255

Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item custom fields null item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the configuration for a custom field associated with a Scoring Rule, including the referenced score field. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the custom field associated with the Scoring Rule. Maximum length: 100
field_label	string	Optional	Represents the display name of the custom field. Required when creating a Scoring Rule. Maximum length: 100
id	string	Optional	Represents the unique ID of the custom field associated with the Scoring Rule. Maximum length: 25
reference_field	Model	Optional	Expand Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item custom fields null item reference field It will hold the referenced score field info. (Required for POST)

Referenced models: Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item custom fields null item reference field

Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item custom fields null item reference field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the referenced score field linked to a custom field in a Scoring Rule. Additional keys: allowed
api_name	string	Optional	Specifies the API name of the referenced score field. Required when creating a Scoring Rule. Known values: Positive_Score, Negative_Score, Touch_Point_Positive_Score, Touch_Point_Negative_Score, Touch_Point_Score, Score
id	string	Optional	Represents the unique ID of the referenced score field. Maximum length: 25

Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item field rules item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the score configuration for module fields based on specific criteria. Additional keys: not allowed
criteria	Model	Optional	Expand Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me criteria value
id	string	Optional	Represents the primary key of the field rule (Required in UPDATE). Maximum length: 255
score	JSON	Optional
score (anyOf 1)	integer	Alternative	Represents the points that should be added for the criteria and this is mandatory Format: int32
score (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get All Custom Views — response body — custom_views / item / access_type: shared, public, only to me, category: public views, other users views, shared with me, created by me criteria value

Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item layout

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Represents the layout associated with a Scoring Rule, including its display label, API name, and unique ID. Additional keys: not allowed
$ (anyOf 1).api_name	string	Optional	Represents the API name of the layout associated with the Scoring Rule. Maximum length: 255
$ (anyOf 1).display_label	string	Optional	Represents the display label of the layout associated with the Scoring Rule. Maximum length: 255
$ (anyOf 1).id	string	Optional	Represents the unique ID of the layout associated with the Scoring Rule. Maximum length: 25
$ (anyOf 2)	null	Alternative	Represents the layout associated with a Scoring Rule, including its display label, API name, and unique ID. Additional keys: not allowed
$ (anyOf 2).api_name	string	Optional	Represents the API name of the layout associated with the Scoring Rule. Maximum length: 255
$ (anyOf 2).display_label	string	Optional	Represents the display label of the layout associated with the Scoring Rule. Maximum length: 255
$ (anyOf 2).id	string	Optional	Represents the unique ID of the layout associated with the Scoring Rule. Maximum length: 25

Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item modified by

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Nested schema for modified_by Additional keys: not allowed
$ (anyOf 1).id	string	Optional	Unique numeric ID of the user who last modified the scoring rule. Maximum length: 25
$ (anyOf 1).name	string	Optional	Full name of the user who last modified the scoring rule. Maximum length: 255
$ (anyOf 1).zuid	string	Optional	Zoho unique ID (ZUID) of the user who last modified the scoring rule. Maximum length: 255
$ (anyOf 2)	null	Alternative	Nested schema for modified_by Additional keys: not allowed
$ (anyOf 2).id	string	Optional	Unique numeric ID of the user who last modified the scoring rule. Maximum length: 25
$ (anyOf 2).name	string	Optional	Full name of the user who last modified the scoring rule. Maximum length: 255
$ (anyOf 2).zuid	string	Optional	Zoho unique ID (ZUID) of the user who last modified the scoring rule. Maximum length: 255

Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the module associated with a Scoring Rule, including the module API name and unique ID. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the module associated with the Scoring Rule. Maximum length: 255
id	string	Optional	Represents the unique ID of the module associated with the Scoring Rule. Maximum length: 25

Scoring Rules — scoring Rules get Scoring Rules — response body — info, scoring rules scoring rules item signal rules null item

Field	Type	Presence	Description and constraints
$	object	Root	Configuration for applying scores based on touch points for Leads and Contacts modules. Additional keys: not allowed
_delete	null	Optional	used to delete the signal rule
id	string	Optional	Signal rule primary key Maximum length: 25
score	JSON	Optional
score (anyOf 1)	integer	Alternative	Points that should be added for the signal (Required for CREATE) Format: int32
score (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
signal	Model	Optional	Expand Update a scoring rules by ID — request body — body scoring rules item signal rules item signal Touch point signal info (Required for CREATE)

Referenced models: Update a scoring rules by ID — request body — body scoring rules item signal rules item signal

Scoring Rules — scoring Rules post Scoring Rules — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body for the create Scoring Rules operation, containing an array of Scoring Rule definitions. Additional keys: not allowed
scoring_rules	array	Required within parent	Represents an array of Scoring Rule definitions to create. Required for POST operations. Maximum items: 20 Minimum items: 1
scoring_rules[]	Model	Each item	Expand Scoring Rules — scoring Rules post Scoring Rules — request body — body scoring rules item

Referenced models: Scoring Rules — scoring Rules post Scoring Rules — request body — body scoring rules item

Scoring Rules — scoring Rules post Scoring Rules — request body — body scoring rules item

Field	Type	Presence	Description and constraints
$	object	Root	Root element for defining a scoring rule, including layout, fields, custom fields, and scoring configurations. Additional keys: not allowed
active	boolean	Optional	It defined the status (active or inactive) of the rule.
custom_fields	array or null	Optional	Custom fields can be configured for scoring rule. These fields will hold the referred scores. Maximum items: 6
custom_fields[]	Model	Each item	Expand Scoring Rules — scoring Rules post Scoring Rules — request body — body scoring rules item custom fields item
description	Model	Optional	Expand Update a scoring rules by ID — request body — body scoring rules item description
field_rules	array	Optional	Specifies an array of field-based score configurations that define criteria and associated scores. Maximum items: 50
field_rules[]	Model	Each item	Expand Update a scoring rules by ID — request body — body scoring rules item field rules item
layout	Model	Optional	Expand Scoring Rules — scoring Rules post Scoring Rules — request body — body scoring rules item layout
module	Model	Required within parent	Expand Scoring Rules — scoring Rules post Scoring Rules — request body — body scoring rules item module
name	string	Required within parent	Scoring rule name. Must be unique within the organization. It cannot contain special characters: ` ~ # % ^ & * ( ) + = " ; < > [ ] { } | \ Maximum length: 25
signal_rules	array or null	Optional	Represents the touch points based score configurations and is applicable only for Leads and Contacts modules Maximum items: 250
signal_rules[]	Model	Each item	Expand Scoring Rules — scoring Rules post Scoring Rules — request body — body scoring rules item signal rules item

Referenced models: Scoring Rules — scoring Rules post Scoring Rules — request body — body scoring rules item custom fields item, Update a scoring rules by ID — request body — body scoring rules item field rules item, Update a scoring rules by ID — request body — body scoring rules item description, Scoring Rules — scoring Rules post Scoring Rules — request body — body scoring rules item layout, Scoring Rules — scoring Rules post Scoring Rules — request body — body scoring rules item module, Scoring Rules — scoring Rules post Scoring Rules — request body — body scoring rules item signal rules item

Scoring Rules — scoring Rules post Scoring Rules — request body — body scoring rules item custom fields item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the configuration for a custom field associated with a Scoring Rule, including the referenced score field. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the custom field associated with the Scoring Rule. Maximum length: 100
field_label	string	Optional	Represents the display name of the custom field. Required when creating a Scoring Rule. Maximum length: 100
id	string	Optional	Represents the unique ID of the custom field associated with the Scoring Rule. Maximum length: 25
reference_field	Model	Optional	Expand Update a scoring rules by ID — request body — body scoring rules item custom fields item reference field It will hold the referenced score field info. (Required for POST)

Referenced models: Update a scoring rules by ID — request body — body scoring rules item custom fields item reference field

Scoring Rules — scoring Rules post Scoring Rules — request body — body scoring rules item layout

Field	Type	Presence	Description and constraints
$	object or null	Root	The layout this scoring rule applies to. Omit or pass null to apply the rule to all layouts. When provided as an object, id and api_name are required. Additional keys: not allowed
api_name	string	Optional	Layout api name Maximum length: 255 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
display_label	string	Optional	layout display name Maximum length: 255
id	string	Optional	Layout id Format: int64 Maximum length: 25 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Scoring Rules — scoring Rules post Scoring Rules — request body — body scoring rules item module

Field	Type	Presence	Description and constraints
$	object	Root	Provides details of a module, including API name and module ID. Additional keys: not allowed
api_name	string	Optional	Api name of the module Maximum length: 255
id	string	Optional	Represents the module id Format: int64 Maximum length: 25

Scoring Rules — scoring Rules post Scoring Rules — request body — body scoring rules item signal rules item

Field	Type	Presence	Description and constraints
$	object	Root	Configuration for applying scores based on touch points for Leads and Contacts modules. The '_delete' key is not supported in POST. Additional keys: not allowed
id	string	Optional	Signal rule primary key Maximum length: 25
score	integer	Optional	Points that should be added for the signal (Required) Format: int32
signal	Model	Optional	Expand Update a scoring rules by ID — request body — body scoring rules item signal rules item signal Touch point signal info (Required)

Referenced models: Update a scoring rules by ID — request body — body scoring rules item signal rules item signal

Scoring Rules — scoring Rules post Scoring Rules — response body — scoring rules scoring rules item

Field	Type	Presence	Description and constraints
$	object	Root	Response details for a scoring rule creation operation, including status, code, and associated messages. Additional keys: not allowed
code	string	Optional	Represents the response code for the scoring rule creation operation Maximum length: 255
details	object	Optional	Details of an operation, including the identifier of affected fields. Additional keys: not allowed
details.id	string	Optional	Represents the created scoring rule id Maximum length: 25
message	string	Optional	Represents the response message for the scoring rule creation operation Maximum length: 255
status	string	Optional	Represents th response status for the scoring rule creation operation Maximum length: 255

Scoring Rules — scoring Rules post Scoring Rules — response body — scoring rules — Create Scoring Rule Success Response

Field	Type	Presence	Description and constraints
$	object	Root	Successful creation response for scoring rules, containing details of the created rules. Additional keys: not allowed
scoring_rules	array	Optional	Represents the response body for a successful create Scoring Rules operation. Maximum items: 20
scoring_rules[]	Model	Each item	Expand Scoring Rules — scoring Rules post Scoring Rules — response body — scoring rules scoring rules item

Referenced models: Scoring Rules — scoring Rules post Scoring Rules — response body — scoring rules scoring rules item

Scoring Rules — scoring Rules post Scoring Rules — response body — scoring rules — Scoring Rules Partial Success Response

Field	Type	Presence	Description and constraints
$	object	Root	Represents the multi-status response body for the create Scoring Rules operation when some items succeed and others fail. Additional keys: not allowed
scoring_rules	array	Optional	Represents an array of per-item operation statuses for the partial success response. Maximum items: 20
scoring_rules[]	Model	Each item	Expand Clone a scoring rule — response body — scoring rules item

Referenced models: Clone a scoring rule — response body — scoring rules item

Scoring Rules — scoring Rules put Scoring Rules — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request body for updating multiple scoring rules. Additional keys: not allowed
scoring_rules	array	Required within parent	Array of scoring rule update objects (Required) Maximum items: 25 Minimum items: 1
scoring_rules[]	Model	Each item	Expand Update a scoring rules by ID — request body — body scoring rules item

Referenced models: Update a scoring rules by ID — request body — body scoring rules item

Scoring Rules — scoring Rules put Scoring Rules — response body — Rules updated successfully

Field	Type	Presence	Description and constraints
$	object	Root	Rules updated successfully Additional keys: not allowed
scoring_rules	array	Optional	Update results for all requested scoring rules. Maximum items: 20
scoring_rules[]	Model	Each item	Expand Clone a scoring rule — response body — scoring rules item

Referenced models: Clone a scoring rule — response body — scoring rules item

Scoring Rules — scoring Rules put Scoring Rules — response body — scoring rules

Field	Type	Presence	Description and constraints
$	object	Root	Represents the multi-status response body for the bulk update Scoring Rules operation when some items succeed and others fail. Additional keys: not allowed
scoring_rules	array	Optional	Represents an array of per-item operation statuses for the multi-status Scoring Rule operation. Maximum items: 300
scoring_rules[]	Model	Each item	Expand Clone a scoring rule — response body — scoring rules item

Referenced models: Clone a scoring rule — response body — scoring rules item

Update a scoring rules by ID — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body schema for bulk update Scoring Rules operations. Additional keys: not allowed
scoring_rules	array	Required within parent	Represents an array of Scoring Rule update objects. Required for PUT operations. Maximum items: 10
scoring_rules[]	Model	Each item	Expand Update a scoring rules by ID — request body — body scoring rules item

Referenced models: Update a scoring rules by ID — request body — body scoring rules item

Update a scoring rules by ID — request body — body scoring rules item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the root element for defining a scoring rule, including layout, fields, custom fields, and scoring configurations. Additional keys: allowed
active	boolean	Optional	It defined the status (active or inactive) of the rule.
custom_fields	array or null	Optional	Represents the custom fields can be configured for scoring rule. These fields will hold the referred scores. Maximum items: 6
custom_fields[]	Model	Each item	Expand Update a scoring rules by ID — request body — body scoring rules item custom fields item
description	Model	Optional	Expand Update a scoring rules by ID — request body — body scoring rules item description
field_rules	array	Optional	Specifies an array of touch point score configurations, available for Leads and Contacts modules. Maximum items: 50
field_rules[]	Model	Each item	Expand Update a scoring rules by ID — request body — body scoring rules item field rules item
id	string	Optional	Represents the Scoring rule id Maximum length: 255
name	string	Optional	Scoring rule name. Must be unique within the organization. It cannot contain special characters: ` ~ # % ^ & * ( ) + = " ; < > [ ] { } | \ Maximum length: 25
signal_rules	array or null	Optional	Represents the touch points based score configurations and is applicable only for Leads and Contacts modules Maximum items: 250
signal_rules[]	Model	Each item	Expand Update a scoring rules by ID — request body — body scoring rules item signal rules item

Referenced models: Update a scoring rules by ID — request body — body scoring rules item custom fields item, Update a scoring rules by ID — request body — body scoring rules item field rules item, Update a scoring rules by ID — request body — body scoring rules item description, Update a scoring rules by ID — request body — body scoring rules item signal rules item

Update a scoring rules by ID — request body — body scoring rules item custom fields item

Field	Type	Presence	Description and constraints
$	object	Root	Configuration for custom fields in PUT request. Supports creating/updating a custom field or deleting one by providing its id with _delete: null. Additional keys: not allowed
_delete	null	Optional	Set to null to delete the custom field
api_name	string	Optional	Api name of the custom field Maximum length: 100
field_label	string	Optional	Name of the custom field Maximum length: 100
id	string	Optional	Custom field id Maximum length: 25
reference_field	Model	Optional	Expand Update a scoring rules by ID — request body — body scoring rules item custom fields item reference field It will hold the referenced score field info.

Referenced models: Update a scoring rules by ID — request body — body scoring rules item custom fields item reference field

Update a scoring rules by ID — request body — body scoring rules item custom fields item reference field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the referenced score field linked to a custom field in a Scoring Rule. Additional keys: allowed
api_name	string	Optional	Specifies the API name of the referenced score field. Required when creating a Scoring Rule. One of: Positive_Score, Negative_Score, Touch_Point_Positive_Score, Touch_Point_Negative_Score, Touch_Point_Score, Score
id	string	Optional	Represents the unique ID of the referenced score field. Maximum length: 25

Update a scoring rules by ID — request body — body scoring rules item description

Field	Type	Presence	Description and constraints
$	string or null	Root	Rule configuration info can be added here. Maximum length: 500

Update a scoring rules by ID — request body — body scoring rules item field rules item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a field-based score configuration entry that links a field criteria condition to a score. Additional keys: not allowed
criteria	Model	Optional	Expand Related Records — request body — query filters
id	string	Optional	Field rule ID Maximum length: 255
score	integer	Optional	Specifies the score points to add when the criteria condition is met. Format: int32

Referenced models: Related Records — request body — query filters

Update a scoring rules by ID — request body — body scoring rules item signal rules item

Field	Type	Presence	Description and constraints
$	object	Root	Configuration for applying scores based on touch points for Leads and Contacts modules. Additional keys: not allowed
_delete	null	Optional	used to delete the signal rule
id	string	Optional	Signal rule primary key Maximum length: 25
score	integer	Optional	Points that should be added for the signal (Required for CREATE) Format: int32
signal	Model	Optional	Expand Update a scoring rules by ID — request body — body scoring rules item signal rules item signal Touch point signal info (Required for CREATE)

Referenced models: Update a scoring rules by ID — request body — body scoring rules item signal rules item signal

Update a scoring rules by ID — request body — body scoring rules item signal rules item signal

Field	Type	Presence	Description and constraints
$	object	Root	Details about touch point signals used in scoring, including signal namespace and ID. Additional keys: not allowed
id	string	Optional	Signal id Maximum length: 25
namespace	string	Optional	Signal namespace Maximum length: 255

Update a scoring rules by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root	Rule successfully updated Additional keys: not allowed
scoring_rules	array	Optional	Update result for the scoring rule, containing the status and ID of the updated rule. Maximum items: 1
scoring_rules[]	Model	Each item	Expand Clone a scoring rule — response body — scoring rules item

Referenced models: Clone a scoring rule — response body — scoring rules item