Zoho: Create a field dependency for a layout

← Map dependency operations · Get started

Operation zoho.createmapdependency

Provider route: POST /crm/v8/settings/layouts/{layoutId}/map_dependency. 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["mapDependency"]["createMapDependency"]>[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.mapDependency.createMapDependency(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.map_dependency.create_map_dependency(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.layoutId	string	Required within parent	Format: int64 Pattern: ^[0-9]+$
query	object	Required within parent	Additional keys: not allowed
query.module	string	Required within parent	Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
body	object	Required within parent	Represents the request body for creating a field dependency between picklist fields in a layout. Additional keys: not allowed
body.map_dependency	array	Required within parent	Specify the field dependency configuration to create. Maximum items: 1
body.map_dependency[]	object	Each item	Specify the configuration for the field dependency to create, including parent field, child field, and picklist value mappings. Additional keys: not allowed
body.map_dependency[].child	Model	Required within parent	Expand Update an existing field dependency — request body — body map dependency item child Child field details
body.map_dependency[].parent	Model	Required within parent	Expand Update an existing field dependency — request body — body map dependency item child Parent field details
body.map_dependency[].pick_list_values	array	Required within parent	Each JSON object in this array corresponds to a specific picklist value in the parent field, and consists of the following keys: - display_value - string, optional - The display name of the picklist value of the parent field. - actual_value - string, optional - The actual name of the picklist value of the parent field. - id - string, mandatory - The unique ID of the picklist value of the parent field. - maps - JSON array, mandatory - The display_value, actual_value, and id of the picklist value of the child field that should be mapped with the parent field. Maximum items: 2000
body.map_dependency[].pick_list_values[]	Model	Each item	Expand Create a field dependency for a layout — request body — body map dependency item pick list values item

Referenced models: Update an existing field dependency — request body — body map dependency item child, Create a field dependency for a layout — request body — body map dependency item pick list values item

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	Represents the success response returned after the field dependency is successfully created. Additional keys: not allowed
map_dependency	array	Required within parent	Contains the result of the create operation. Maximum items: 1
map_dependency[]	Model	Each item	Expand Delete a field dependency — response body — map dependency item

Referenced models: Delete a field dependency — response body — map dependency item

Schemas

Update an existing field dependency — request body — body map dependency item child

Field	Type	Presence	Description and constraints
$	object	Root	Represents a reference to a field, identified by its unique ID and API name. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the field. Maximum length: 50
id	string	Required within parent	Represents the unique identifier of the field. Format: int64

Delete a field dependency — response body — map dependency item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the success response returned after a create, update, or delete operation. Additional keys: not allowed
code	string	Required within parent	Represents the success code for the operation. Possible values: **SUCCESS**. Known values: SUCCESS
details	object	Required within parent	Contains the result details for the operation. Additional keys: not allowed
details.id	string	Required within parent	Represents the unique identifier of the dependency the operation created, updated, or deleted. Format: int64
message	string	Required within parent	Describes the result of the operation. Maximum length: 500
status	string	Required within parent	Represents the status of the operation. Possible values: **success**. Known values: success

Create a field dependency for a layout — request body — body map dependency item pick list values item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a parent picklist option and its mapped child picklist values for dependency creation. Additional keys: not allowed
actual_value	string	Optional	Represents the actual stored value of the parent picklist option. Maximum length: 120
display_value	string	Optional	Represents the display label of the parent picklist option as shown in the CRM interface. Maximum length: 120
id	string	Required within parent	Represents the unique identifier of the parent picklist option. Use the [Get Fields API](fields.yaml#$.paths./settings/fields.get) to get the ID of the picklist. Format: int64
maps	array	Required within parent	Lists the child picklist options associated with this parent picklist value. Maximum items: 2000
maps[]	object	Each item	Each object represents a child picklist option mapped to this parent value. Additional keys: not allowed
maps[].actual_value	string	Optional	Represents the actual stored value of the child picklist option. Maximum length: 120
maps[].display_value	string	Optional	Represents the display label of the child picklist option as shown in the CRM interface. Maximum length: 120
maps[].id	string	Required within parent	Represents the unique identifier of the child picklist option. Use the [Get Fields API](fields.yaml#$.paths./settings/fields.get) to get the details of the picklist. Format: int64

Policy, approvals and errors

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