Zoho: Get Zia Enrichment Configuration for a specific module

← Zia enrichment operations · Get started

Operation zoho.getspecificziaenrichmentconfiguration

Provider route: GET /crm/v8/settings/zia/data_enrichment/{id}. 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["ziaEnrichment"]["getSpecificZiaEnrichmentConfiguration"]>[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.ziaEnrichment.getSpecificZiaEnrichmentConfiguration(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.zia_enrichment.get_specific_zia_enrichment_configuration(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.id	string	Required within parent	Unique identifier of the Data Enrichment configuration to retrieve. Maximum length: 19

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
$	JSON	Root
$ (anyOf 1)	object	Alternative	Data enrichment configuration fetched successfully. Additional keys: not allowed
$ (anyOf 1).data_enrichment	array	Required within parent	Array containing the requested enrichment configuration. Maximum items: 50
$ (anyOf 1).data_enrichment[]	object	Each item	Enrichment configuration item for a specific module. Additional keys: not allowed
$ (anyOf 1).data_enrichment[].created_by	object	Optional	User who created the enrichment configuration. Additional keys: not allowed
$ (anyOf 1).data_enrichment[].created_by.id	string	Required within parent	Unique identifier of the user who created the configuration. Maximum length: 19
$ (anyOf 1).data_enrichment[].created_by.name	string	Required within parent	Name of the user who created the configuration. Maximum length: 255
$ (anyOf 1).data_enrichment[].created_time	string	Optional	Timestamp when the configuration was created. Maximum length: 255
$ (anyOf 1).data_enrichment[].id	string	Required within parent	Unique identifier of the enrichment configuration. Maximum length: 19
$ (anyOf 1).data_enrichment[].input_data_field_mapping	Model	Required within parent	Expand Data Enrichment — response body — data enrichment data enrichment item input data field mapping
$ (anyOf 1).data_enrichment[].modified_by	object	Required within parent	User who last modified the enrichment configuration. Additional keys: not allowed
$ (anyOf 1).data_enrichment[].modified_by.id	string	Required within parent	Unique identifier of the user who last modified the configuration. Maximum length: 19
$ (anyOf 1).data_enrichment[].modified_by.name	string	Required within parent	Name of the user who last modified the configuration. Maximum length: 255
$ (anyOf 1).data_enrichment[].modified_time	string	Required within parent	Timestamp when the configuration was last modified. Maximum length: 255
$ (anyOf 1).data_enrichment[].module	Model	Required within parent	Expand Zia Data Enrichment Configuration — request body — body data enrichment item module
$ (anyOf 1).data_enrichment[].output_data_field_mapping	Model	Required within parent	Expand Data Enrichment — response body — data enrichment data enrichment item input data field mapping
$ (anyOf 1).data_enrichment[].status	boolean	Required within parent	Whether the enrichment configuration is active.
$ (anyOf 1).data_enrichment[].type	string	Required within parent	Type of enrichment — ‘personal’ or ‘organization’. Maximum length: 255
$ (anyOf 2)	null	Alternative

Referenced models: Data Enrichment — response body — data enrichment data enrichment item input data field mapping, Zia Data Enrichment Configuration — request body — body data enrichment item module

Schemas

Data Enrichment — response body — data enrichment data enrichment item input data field mapping

Field	Type	Presence	Description and constraints
$	array	Root	Array of field mappings for read operations. Maximum items: 50
$[]	object	Each item	Field mapping item for read operations. Additional keys: not allowed
$[].crm_field	JSON	Required within parent	CRM field object with additional display name.
$[].crm_field (anyOf 1)	object	Alternative	CRM field object with ID, API name, and display name. Additional keys: not allowed
$[].crm_field (anyOf 1).api_name	string	Required within parent	API name of the CRM field. Maximum length: 255
$[].crm_field (anyOf 1).id	string	Required within parent	Unique identifier of the CRM field. Maximum length: 19
$[].crm_field (anyOf 1).name	string	Optional	Display name of the CRM field. Maximum length: 255
$[].crm_field (anyOf 2)	null	Alternative	Null value for CRM field (no mapping).
$[].enrich_field	object	Required within parent	Zia enrichment field metadata with display label. Additional keys: not allowed
$[].enrich_field.display_label	string	Required within parent	Display label of the Zia enrichment field. Maximum length: 255
$[].enrich_field.name	string	Required within parent	Name of the Zia enrichment field. Maximum length: 255

Zia Data Enrichment Configuration — request body — body data enrichment item module

Field	Type	Presence	Description and constraints
$	object	Root	CRM module metadata with ID and API name. Additional keys: not allowed
api_name	string	Required within parent	API name of the CRM module (e.g., Leads, Contacts, Accounts). Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to get module API names. Maximum length: 255
id	string	Required within parent	Unique identifier of the CRM module. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to get module IDs. Maximum length: 19

Policy, approvals and errors

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

No-content response statuses: [204]

Official provider source