Zoho: Delete a scoring rules by ID

← Scoring rules operations · Get started

Operation zoho.deletescoringrulebyid

Provider route: DELETE /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"]["deleteScoringRuleById"]>[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.deleteScoringRuleById(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.delete_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

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 Delete a scoring rules by ID — response body

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

Schemas

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

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

Policy, approvals and errors

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