Zoho: Clone Assignment Rule Entries

Zoho assignmentRules.putCloneEntries: arguments, response, policy and SDK examples.

← Assignment rules operations · Get started

Operation zoho.putcloneentries

Provider route: PUT /crm/v8/settings/automation/assignment_rules/{id}/actions/clone_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"]["putCloneEntries"]>[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.putCloneEntries(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_clone_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 Clone Assignment Rule Entries — request body — body

Referenced models: Clone 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

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

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

Clone Assignment Rule Entries — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Specifies the request structure for cloning rule entries in an Assignment Rule. Additional keys: not allowed
`assignment_rules`	array	Required within parent	Specify the assignment_rules array that contains the rule entries to clone into the target Assignment Rule. Maximum items: 1 Minimum items: 1
`assignment_rules[]`	object	Each item	Specify each Assignment Rule object that contains the rule entries to clone. Additional keys: not allowed
`assignment_rules[].rule_entries`	array	Required within parent	Specify the list of rule entries to clone while retaining their order and configuration in the target Assignment Rule. Maximum items: 1 Minimum items: 1
`assignment_rules[].rule_entries[]`	Model	Each item	Expand Clone Assignment Rule Entries — request body — body assignment rules item rule entries item

Referenced models: Clone 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

Clone 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 update. Additional keys: not allowed
`allow_agent_user`	boolean	Optional	Indicates whether Digital Employee (agent) users are eligible for assignment in this rule entry.
`assign_to`	Model	Optional	Expand Create an Assignment Rule — request body — body assignment rules item rule entries item assign to This field defines the set of users to whom the records that enter the current rule entry must be assigned. (Required)
`criteria`	Model	Optional	Expand Create an Assignment Rule — request body — body assignment rules item rule entries item criteria Defines the record criteria based on which records will be filtered and assignment logic defined for current rule entry will be applied. If criteria is not provided or is null, all records entering current rule entry will be assigned based on current rule entry's assignment logic.
`followup_actions`	array or null	Optional	Defines the list of different actions to be executed after owner assignment. Maximum items: 1 Minimum items: 1
`followup_actions[]`	Model	Each item	Expand Create an Assignment Rule — request body — body assignment rules item rule entries item followup actions item
`id`	string	Required within parent	ID of the resource. Maximum length: 19 Minimum length: 1 Pattern: ^[1-9][0-9]{0,18}$
`user_availability_based_on`	array or null	Optional	Defines additional availability checks to be performed before choosing a user as owner. A user is assigned as owner only if it satisfies the mentioned availability conditions. Maximum items: 2
`user_availability_based_on[]`	string	Each item	Specify each user availability based on entry in the Assignment Rule request. Possible values: online_status - Represents online status. shift_timing - Represents shift timing. One of: online_status, shift_timing

Referenced models: Create an Assignment Rule — request body — body assignment rules item rule entries item assign to, Create an Assignment Rule — request body — body assignment rules item rule entries item followup actions item, Create an Assignment Rule — request body — body assignment rules item rule entries item criteria

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

Create an Assignment Rule — request body — body assignment rules item rule entries item assign to

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Assign to request object schema.
`$ (anyOf 1)`	Model	Alternative	Expand Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: zia suggested users
`$ (anyOf 2)`	Model	Alternative	Expand Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: role
`$ (anyOf 3)`	Model	Alternative	Expand Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: group
`$ (anyOf 4)`	Model	Alternative	Expand Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: profile
`$ (anyOf 5)`	Model	Alternative	Expand Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: users
`$ (anyOf 6)`	Model	Alternative	Expand Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: criteria

Referenced models: Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: criteria, Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: group, Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: profile, Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: role, Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: users, Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / assign_to / type: zia suggested users

Create an Assignment Rule — request body — body assignment rules item rule entries item followup actions item

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Followup action to execute after ownership assignment. Currently supports tasks. Additional types may be added in future versions.
`$ (anyOf 1)`	Model	Alternative	Expand Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / followup_actions / item / type: tasks

Referenced models: Create an Assignment Rule — request body — body / assignment_rules / item / rule_entries / item / followup_actions / item / type: tasks

Create an Assignment Rule — request body — body assignment rules item rule entries item criteria

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Filter criteria for data selection supporting both simple field-based filters and complex grouped filters with logical operators. Additional keys: allowed
`$ (anyOf 1)`	Model	Alternative	Expand Related Records — request body — query filters
`$ (anyOf 2)`	null	Alternative	To remove criteria from an existing rule entry, set criteria as null in update request.

Referenced models: Related Records — request body — query filters

Policy, approvals and errors

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

Report an issue with this page