Zoho: Update Module Labels and Profiles

← Modules operations · Get started

Operation zoho.updatemodulebyapiname

Provider route: PUT /crm/v8/settings/modules/{moduleIdentifier}. 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"]["updateModuleByApiName"]>[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.updateModuleByApiName(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.update_module_by_api_name(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	Model	Required within parent	Expand Get module metadata by API name — request body — path
body	object	Required within parent	Request body schema for updating a module. Contains a single-element modules array with the module ID, updated labels, and profile assignments Additional keys: not allowed
body.modules	array	Required within parent	Single-element array containing the module object with the labels and profile assignments to update. Exactly one item is required. Maximum items: 1 Minimum items: 1
body.modules[]	object	Each item	Module object specifying the updated singular label, plural label, identifier, and profile assignments. Additional keys: not allowed
body.modules[].id	string	Required within parent	Unique numeric identifier of the module to update. Must match an existing module. Represented as a numeric string encoding a 64-bit positive integer (Java long/DB bigint). Format: int64
body.modules[].plural_label	string	Required within parent	Plural display label for the module. Accepts 1–50 alphanumeric characters and spaces; special characters are not permitted. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z0-9 ]+$
body.modules[].profiles	array	Required within parent	Non-empty list of unique profiles that should have access to this module. Accepts 1–203 unique profile objects; order is not significant. This cannot be empty. Maximum items: 203 Minimum items: 1 Unique items: true
body.modules[].profiles[]	object	Each item	Profile object specifying a single profile to grant access to the module. Contains the profile numeric identifier. Additional keys: not allowed
body.modules[].profiles[].id	string	Required within parent	Unique numeric identifier of the profile. Represented as a numeric string encoding a 64-bit positive integer. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
body.modules[].singular_label	string	Required within parent	Singular display label for the module. Accepts 1–50 alphanumeric characters and spaces; special characters are not permitted. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z0-9 ]+$

Referenced models: Get module metadata by API name — request body — path

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
$	object	Root	Response body schema for a successful module update. Contains a single-element module array with the outcome code, updated module ID, confirmation message, and status Additional keys: not allowed
modules	array	Required within parent	Single-element array containing the success result for the updated module. Maximum items: 1 Minimum items: 1
modules[]	object	Each item	Success result object containing the operation outcome code, the updated module identifier, a confirmation message, and a status indicator. Additional keys: not allowed
modules[].code	string	Required within parent	Always “SUCCESS”. Indicates the module update completed without errors. Known values: SUCCESS
modules[].details	object	Required within parent	Contains the identifier of the successfully updated module. Additional keys: not allowed
modules[].details.id	string	Required within parent	Unique numeric identifier of the successfully updated module. Represented as a numeric string encoding a 64-bit positive integer(Java long/DB bigint). Format: int64
modules[].message	string	Required within parent	Displays the success message and confirms that the update was applied. Known values: module updated successfully
modules[].status	string	Required within parent	Indicates that the operation completed successfully. Known values: success

Schemas

Get module metadata by API name — request body — path

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
moduleIdentifier	JSON	Required within parent
moduleIdentifier (anyOf 1)	string	Alternative	Unique numeric identifier. Numeric string representation of a 64-bit positive integer. Format: int64
moduleIdentifier (anyOf 2)	string	Alternative	API name of the module to retrieve. Case-sensitive identifier following specific naming rules: must start with a letter, contain only alphanumeric characters and underscores, cannot have consecutive underscores, and must end with alphanumeric character. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*[A-Za-z0-9]$

Policy, approvals and errors

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