Zoho: Generate web-tab link for a module

← Modules operations · Get started

Operation zoho.getgeneratelink

Provider route: GET /crm/v8/settings/module/{moduleid}/actions/generate_link. 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["modules"]["getGenerateLink"]>[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.modules.getGenerateLink(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.modules.get_generate_link(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.moduleid	string	Required within parent	Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*[A-Za-z0-9]$

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 Generate web-tab link for a module — response body

Referenced models: Generate web-tab link for a module — response body

Schemas

Generate web-tab link for a module — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response containing the generated web tab link for a CRM module, with the link details available in the generate_link property. Additional keys: not allowed
generate_link	Model	Required within parent	Expand Generate web-tab link for a module — response body — generate link

Referenced models: Generate web-tab link for a module — response body — generate link

Generate web-tab link for a module — response body — generate link

Field	Type	Presence	Description and constraints
$	object	Root	Represents a web tab link associated with a CRM module, including the tab identifier (id, int64), display name(name), and configured URL(web_link). Additional keys: not allowed
id	string	Required within parent	Represents the unique ID of the web tab. Format: int64 Maximum length: 20 Minimum length: 18 Pattern: \d+
name	string	Required within parent	Represents the display name of the web tab. Maximum length: 50 Minimum length: 3
web_link	string	Required within parent	Represents the URL configured for the web tab. Maximum length: 1000

Policy, approvals and errors

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