Zoho: Scoring Rules — scoring Rules post Scoring Rules

← Scoring rules operations · Get started

Operation zoho.postscoringrules

Provider route: POST /crm/v8/settings/automation/scoring_rules. 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"]["postScoringRules"]>[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.postScoringRules(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.post_scoring_rules(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Optional	Expand Scoring Rules — scoring Rules post Scoring Rules — request body — body

Referenced models: Scoring Rules — scoring Rules post Scoring Rules — 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
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Scoring Rules — scoring Rules post Scoring Rules — response body — scoring rules — Create Scoring Rule Success Response
$ (anyOf 2)	Model	Alternative	Expand Scoring Rules — scoring Rules post Scoring Rules — response body — scoring rules — Scoring Rules Partial Success Response

Referenced models: Scoring Rules — scoring Rules post Scoring Rules — response body — scoring rules — Create Scoring Rule Success Response, Scoring Rules — scoring Rules post Scoring Rules — response body — scoring rules — Scoring Rules Partial Success Response

Schemas

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

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

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

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

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

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

Policy, approvals and errors

SDK function policy ID: zoho.postscoringrules. Catalog operation: postScoringRules. 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