Zoho: Update a scoring rules by ID

← Scoring rules operations · Get started

Operation zoho.putscoringrulebyid

Provider route: PUT /crm/v8/settings/automation/scoring_rules/{ruleId}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["scoringRules"]["putScoringRuleById"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.scoringRules.putScoringRuleById(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.scoring_rules.put_scoring_rule_by_id(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.ruleId	string	Required within parent	Maximum length: 20
body	Model	Optional	Expand Update a scoring rules by ID — request body — body

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

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Update a scoring rules by ID — response body

Referenced models: Update a scoring rules by ID — response body

Schemas

17 more schemas are linked from the tables above, on the schema pages.

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

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

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

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

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

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 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 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 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

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

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

Policy, approvals and errors

SDK function policy ID: zoho.putscoringrulebyid. Catalog operation: putScoringRuleById. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source