Zoho: Reorder Assignment Rule entries

← Assignment rules operations · Get started

Operation zoho.putreorderentries

Provider route: PUT /crm/v8/settings/automation/assignment_rules/{id}/actions/reorder_entries. 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["assignmentRules"]["putReorderEntries"]>[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.assignmentRules.putReorderEntries(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.assignment_rules.put_reorder_entries(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.id	string	Required within parent	Maximum length: 19 Minimum length: 1 Pattern: ^[1-9][0-9]{0,18}$
query	object	Required within parent	Additional keys: not allowed
query.module	string	Required within parent	Maximum length: 100
body	Model	Optional	Expand Reorder Assignment Rule entries — request body — body

Referenced models: Reorder Assignment Rule entries — 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 Clone Assignment Rule — response body

Referenced models: Clone Assignment Rule — response body

Schemas

Clone Assignment Rule — response body

Field	Type	Presence	Description and constraints
$	object	Root	Successful API operation completed. Additional keys: not allowed
assignment_rules	array	Optional	Represents the Assignment Rules returned for the Assignment Rule operation. Maximum items: 1 Minimum items: 1
assignment_rules[]	Model	Each item	Expand Clone Assignment Rule — response body — assignment rules item details of assignment rule created/cloned/updated/deleted

Referenced models: Clone Assignment Rule — response body — assignment rules item

Reorder Assignment Rule entries — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request body for reordering entries of an Assignment Rule. Additional keys: not allowed
assignment_rules	array	Required within parent	Array of Assignment Rule objects to be created. Maximum items: 1 Minimum items: 1
assignment_rules[]	object	Each item	Specify each Assignment Rules entry in the Assignment Rule request. Additional keys: not allowed
assignment_rules[].rule_entries	array	Required within parent	Specify the list of rule entries with updated sequence number for reordering. Maximum items: 200 Minimum items: 1
assignment_rules[].rule_entries[]	Model	Each item	Expand Reorder Assignment Rule entries — request body — body assignment rules item rule entries item

Referenced models: Reorder Assignment Rule entries — request body — body assignment rules item rule entries item

Clone Assignment Rule — response body — assignment rules item

Field	Type	Presence	Description and constraints
$	object	Root	Details of successfully created/cloned/deleted/updated Assignment Rules, including code, message, and status. Additional keys: not allowed
code	string	Optional	Represents the status code that identifies the result of the Assignment Rule operation. Possible values: **SUCCESS** - Represents success. Known values: SUCCESS
details	Model	Optional	Expand Clone Assignment Rule — response body — assignment rules item details
message	string	Optional	Represents the message that describes the result of the Assignment Rule operation. Maximum length: 255
status	string	Optional	Represents the status of the Assignment Rule operation. Possible values: **success** - Represents success. Known values: success

Referenced models: Clone Assignment Rule — response body — assignment rules item details

Reorder Assignment Rule entries — request body — body assignment rules item rule entries item

Field	Type	Presence	Description and constraints
$	object	Root	Rule entry request object to delete. Additional keys: not allowed
id	string	Required within parent	ID of the resource. Maximum length: 19 Minimum length: 1 Pattern: ^[1-9][0-9]{0,18}$
sequence_number	integer	Required within parent	Entry order of the rule entry. This property can be updated only using reorder_entries API. Format: int32

Clone Assignment Rule — response body — assignment rules item details

Field	Type	Presence	Description and constraints
$	object	Root	Represents additional details about the Assignment Rule operation result. Additional keys: not allowed
id	string	Required within parent	ID of the resource. Maximum length: 19 Minimum length: 1 Pattern: ^[1-9][0-9]{0,18}$
rule_entries	array	Optional	Represents the rule entries returned for the Assignment Rule operation. Maximum items: 200 Minimum items: 1
rule_entries[]	object	Each item	Represents each rule entries entry returned for the Assignment Rule operation. Additional keys: not allowed
rule_entries[].id	string	Required within parent	ID of the resource. Maximum length: 19 Minimum length: 1 Pattern: ^[1-9][0-9]{0,18}$

Policy, approvals and errors

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