Zoho: Generate API Name — variable Groups generate Api Name

← Variable groups operations · Get started

Operation zoho.generateapiname

Provider route: POST /crm/v8/settings/variable_groups/actions/generate_api_name. 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["variableGroups"]["generateApiName"]>[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.variableGroups.generateApiName(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.variable_groups.generate_api_name(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Optional	Expand Generate API Name — variable Groups generate Api Name — request body — body

Referenced models: Generate API Name — variable Groups generate Api Name — 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 Generate API Name — variable Groups generate Api Name — response body

Referenced models: Generate API Name — variable Groups generate Api Name — response body

Schemas

Generate API Name — variable Groups generate Api Name — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body for the generate API name operation. Additional keys: not allowed
variable_groups	array	Required within parent	Represents an array containing a single variable group item submitted for API name generation. Maximum items: 1 Minimum items: 1
variable_groups[]	Model	Each item	Expand Generate API Name — variable Groups generate Api Name — request body — body variable groups item

Referenced models: Generate API Name — variable Groups generate Api Name — request body — body variable groups item

Generate API Name — variable Groups generate Api Name — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response body for a successful generate API name operation. Additional keys: not allowed
variable_groups	array	Optional	Represents an array of per-item results containing the generated API names for each submitted variable group. Maximum items: 1
variable_groups[]	Model	Each item	Expand Update variable group by ID — response body — variable groups item

Referenced models: Update variable group by ID — response body — variable groups item

Generate API Name — variable Groups generate Api Name — request body — body variable groups item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single variable group item submitted for API name generation. Additional keys: not allowed
name	string	Required within parent	Represents the proposed name of the variable group for which an available API name is generated. Maximum length: 50

Update variable group by ID — response body — variable groups item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the per-item operation result for a variable group action, including the status code, message, and optional field path details. Additional keys: not allowed
code	string	Optional	Represents the status code for the individual variable group operation result. Maximum length: 255
details	Model	Optional	Expand Update variable group by ID — response body — variable groups item details
message	string	Optional	Represents the message describing the result of the individual variable group operation. Maximum length: 255
status	string	Optional	Represents the status of the individual variable group operation result. Maximum length: 255

Referenced models: Update variable group by ID — response body — variable groups item details

Update variable group by ID — response body — variable groups item details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the field path details returned in per-item operation results, providing context about which field the result pertains to. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the variable group field that the operation result refers to. Maximum length: 255
id	string	Optional	Represents the unique ID of the variable group field that the operation result refers to. Maximum length: 255

Policy, approvals and errors

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