Zoho: Variable Associations

← Variables operations · Get started

Operation zoho.getvariableassociations

Provider route: GET /crm/v8/settings/variables/{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["variables"]["getVariableAssociations"]>[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.variables.getVariableAssociations(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.variables.get_variable_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: 255

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 Variable Associations — response body

Referenced models: Variable Associations — response body

Schemas

Variable Associations — response body

Field	Type	Presence	Description and constraints
$	object	Root	Success response containing an array of variable association groups for the requested context. Additional keys: not allowed
variables_associations	array	Required within parent	Array of variable association groups, each containing the association type and related resources. Maximum items: 1
variables_associations[]	Model	Each item	Expand Variable Associations — response body — variables associations item

Referenced models: Variable Associations — response body — variables associations item

Variable Associations — response body — variables associations item

Field	Type	Presence	Description and constraints
$	object	Root	Grouping of variable associations under a named category, including the list of associated resources. Additional keys: not allowed
name	string	Required within parent	The name of the association category (for example, email_templates). Maximum length: 255
resources	array	Required within parent	Array of resources associated with this variable under this category. Maximum items: 1
resources[]	Model	Each item	Expand Variable Associations — response body — variables associations item resources item

Referenced models: Variable Associations — response body — variables associations item resources item

Variable Associations — response body — variables associations item resources item

Field	Type	Presence	Description and constraints
$	object	Root	A resource associated with variables, including name, id, and nested association details. Additional keys: not allowed
details	Model	Required within parent	Expand Variable Associations — response body — variables associations item resources item details
id	string	Required within parent	The unique ID of the associated resource. Format: int64 Maximum length: 19
name	string	Required within parent	The name of the associated resource. Maximum length: 255

Referenced models: Variable Associations — response body — variables associations item resources item details

Variable Associations — response body — variables associations item resources item details

Field	Type	Presence	Description and constraints
$	object	Root	Details about a resource association, including the referenced module. Additional keys: not allowed
module	Model	Required within parent	Expand Variable Associations — response body — variables associations item resources item details module

Referenced models: Variable Associations — response body — variables associations item resources item details module

Variable Associations — response body — variables associations item resources item details module

Field	Type	Presence	Description and constraints
$	object	Root	Minimal reference to a module used in association details, containing id and apiName. Additional keys: not allowed
api_name	string	Required within parent	The API name of the CRM module. Maximum length: 255
id	string	Required within parent	The unique ID of the CRM module. Format: int64

Policy, approvals and errors

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