Zoho: Assignment Rule Associations

← Assignment rules operations · Get started

Operation zoho.getassignmentruleassociations

Provider route: GET /crm/v8/settings/automation/assignment_rules/{id}/actions/associations. 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"]["getAssignmentRuleAssociations"]>[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.getAssignmentRuleAssociations(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.get_assignment_rule_associations(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

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 Assignment Rule Associations — response body — associations
$ (anyOf 2)	null	Alternative

Referenced models: Assignment Rule Associations — response body — associations

Schemas

Assignment Rule Associations — response body — associations

Field	Type	Presence	Description and constraints
$	object	Root	Contains the response structure for Assignment Rule association details. Additional keys: not allowed
associations	array	Optional	Contains the CRM features associated with the Assignment Rule. Maximum items: 200 Minimum items: 1
associations[]	Model	Each item	Expand Assignment Rule Associations — response body — associations associations item

Referenced models: Assignment Rule Associations — response body — associations associations item

Assignment Rule Associations — response body — associations associations item

Field	Type	Presence	Description and constraints
$	object	Root	List of features in which Assignment Rule is associated. Additional keys: not allowed
resources	array	Optional	Represents the list of features in which Assignment Rule is associated. Maximum items: 1
resources[]	Model	Each item	Expand Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module
type	string	Optional	Represents the type returned for the Assignment Rule operation. Maximum length: 255

Referenced models: Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module

Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module

Field	Type	Presence	Description and constraints
$	object	Root	Resource details. Additional keys: allowed
_details	Model	Optional	Expand Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module details
api_name	string	Optional	Represents the API name of the resource. Maximum length: 255
id	string	Required within parent	ID of the resource. Id of the resource Maximum length: 19 Minimum length: 1 Pattern: ^[1-9][0-9]{0,18}$
name	string	Required within parent	Represents the display name of the resource. Maximum length: 255
zuid	string	Optional	Zuid of the user resource Format: int32 Maximum length: 19

Referenced models: Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module details

Assignment Rules — response body — Get all Assignment Rules success response assignment rules item module details

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	null	Alternative	_Details Schema. Additional keys: allowed
$ (anyOf 2)	object	Alternative	_Details Schema. Additional keys: allowed

Policy, approvals and errors

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

No-content response statuses: [204]

Official provider source