Zoho: Create an Assignment Rule

← Assignment rules operations · Get started

Operation zoho.postassignmentrules

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

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.module	string	Required within parent	Maximum length: 100
body	Model	Optional	Expand Create an Assignment Rule — request body — body

Referenced models: Create an Assignment Rule — 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

29 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

Create an Assignment Rule — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request body for creating 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[].api_name	string	Optional	Specify the aPI name of the rule. Maximum length: 100 Minimum length: 1
assignment_rules[].default_assignee	Model	Optional	Expand Create an Assignment Rule — request body — body assignment rules item default assignee
assignment_rules[].description	string	Optional	Purpose of the Assignment Rule. Maximum length: 250
assignment_rules[].name	string	Required within parent	Specify the name to be displayed for the Assignment Rule. Maximum length: 100 Minimum length: 1
assignment_rules[].rule_entries	array	Required within parent	Specify the list of rule entries for creation. Maximum items: 200 Minimum items: 1
assignment_rules[].rule_entries[]	Model	Each item	Expand Create an Assignment Rule — request body — body assignment rules item rule entries item

Referenced models: Create an Assignment Rule — request body — body assignment rules item default assignee, Create an Assignment Rule — 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

Create an Assignment Rule — request body — body assignment rules item default assignee

Field	Type	Presence	Description and constraints
$	JSON	Root	Fallback assignee when no rule entry matches. Currently supports user type. Additional types (for example, queue) may be added in future versions.
$ (anyOf 1)	Model	Alternative	Expand Create an Assignment Rule — request body — body / assignment_rules / item / default_assignee / type: user

Referenced models: Create an Assignment Rule — request body — body / assignment_rules / item / default_assignee / type: user

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

Field	Type	Presence	Description and constraints
$	object	Root	Defines entries with matching and assignment logic for record processing. Additional keys: not allowed
assign_to	Model	Required within parent	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
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 / default_assignee / type: user

Field	Type	Presence	Description and constraints
$	object	Root	Configures a specific user or the currently logged-in user as the default assignee. Additional keys: not allowed
resource	JSON	Required within parent	Specify the resource for the Assignment Rule request.
resource (anyOf 1)	Model	Alternative	Expand Create an Assignment Rule — request body — body / assignment_rules / item / default_assignee / type: user resource User resource reference for Assignment Rule entry Specific user to set as the default assignee
resource (anyOf 2)	object	Alternative	Defines the logged-in user as the default assignee. Additional keys: not allowed
resource (anyOf 2).api_name	string	Optional	Set ${CURRENTUSER} to use the logged-in user as the default assignee. Possible values: **${CURRENTUSER}** - Represents ${currentuser}. One of: ${CURRENTUSER}
type	string	Required within parent	Default assignee type. Must be 'user'. Possible values: **user** - Represents user. One of: user

Referenced models: Create an Assignment Rule — request body — body / assignment_rules / item / default_assignee / type: user resource User resource reference for Assignment Rule entry

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.postassignmentrules. Catalog operation: postAssignmentRules. 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