Zoho: Get Associated Modules for Automation Functions
Zoho automationFunctions.getAssociatedModules: arguments, response, policy and SDK examples.
← Automation functions operations · Get started
Operation zoho.getassociatedmodules
Provider route: GET /crm/v8/settings/automation/functions/actions/associated_modules. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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["automationFunctions"]["getAssociatedModules"]>[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.automationFunctions.getAssociatedModules(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.automation_functions.get_associated_modules(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
Response
Section titled “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 Get Associated Modules for Automation Functions — response body |
Referenced models: Get Associated Modules for Automation Functions — response body
Schemas
Section titled “Schemas”Get Associated Modules for Automation Functions — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response containing the list of modules associated with automation functions. Additional keys: not allowed |
associated_modules | array | Required within parent | Represents the list of CRM modules associated with the automation functions. Maximum items: 12 |
associated_modules[] | Model | Each item | Expand Get Associated Modules for Automation Functions — response body — associated modules item |
Referenced models: Get Associated Modules for Automation Functions — response body — associated modules item
Get Associated Modules for Automation Functions — response body — associated modules item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A reference to a CRM module associated with an automation function, identified by its API name and unique ID. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the associated CRM module. Maximum length: 255 |
id | string | Required within parent | Represents the unique ID of the associated CRM module. Format: int64 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.getassociatedmodules. Catalog operation: getAssociatedModules. 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.