Zoho: Trigger organization-level enrichment for a CRM record

← Zia org enrichment operations · Get started

Operation zoho.submitorgenrichmentrequest

Provider route: POST /crm/v8/__zia_org_enrichment. 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["ziaOrgEnrichment"]["submitOrgEnrichmentRequest"]>[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.ziaOrgEnrichment.submitOrgEnrichmentRequest(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_org_enrichment.submit_org_enrichment_request(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.module	string	Required within parent	CRM module name from which enrichment is triggered. Maximum length: 255
query.record_id	string	Optional	Unique CRM record ID for which enrichment is requested. Maximum length: 19
body	object	Required within parent	Defines the body of a Zia organization enrichment request. Wraps the list of enrichment inputs under the `__zia_org_enrichment` key. Additional keys: not allowed
body.__zia_org_enrichment	array	Required within parent	Specify the list of enrichment requests to schedule. You can supply up to 50 entries in a single call. Maximum items: 50
body.__zia_org_enrichment[]	object	Each item	Represents a single Zia organization enrichment request that defines the trigger fields used to identify the organization. Additional keys: not allowed
body.__zia_org_enrichment[].enrich_based_on	object	Required within parent	Specify the details of the fields on whose values you want to trigger enrichment. Note that you must provide at least one of the following values in the input. Based on these values, Zia will look for information on the web and enrich fields as per [Enrichment Configuration.](zia_enrichment.yaml#$.paths./settings/zia/data_enrichment.get)) Note that the values of these keys must be at least three characters long and only in English. Additional keys: not allowed
body.__zia_org_enrichment[].enrich_based_on.email	string	Optional	Specify the email address of the organization that Zia uses as a trigger value to look up enrichment data. Format: email
body.__zia_org_enrichment[].enrich_based_on.name	string	Required within parent	Specify the name of the organization that Zia uses as a trigger value to look up enrichment data. Maximum length: 255
body.__zia_org_enrichment[].enrich_based_on.website	string	Optional	Specify the website domain of the organization that Zia uses as a trigger value to look up enrichment data. Format: website

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	Defines the response body returned when a Zia organization enrichment job is successfully scheduled. Additional keys: not allowed
__zia_org_enrichment	array	Required within parent	Contains the list of scheduling results, one entry per submitted enrichment request. Maximum items: 50
__zia_org_enrichment[]	object	Each item	Represents the scheduling result of a single enrichment request. Additional keys: not allowed
__zia_org_enrichment[].code	string	Required within parent	Indicates the scheduling outcome of the enrichment request. Possible values: SCHEDULED - The enrichment job has been queued for asynchronous execution. Known values: SCHEDULED
__zia_org_enrichment[].details	object	Required within parent	Contains identifying information about the scheduled enrichment job. Additional keys: not allowed
__zia_org_enrichment[].details.id	string	Required within parent	Shows the unique identifier assigned to the scheduled enrichment job. Use this identifier with GET `/__zia_org_enrichment/{id}` to retrieve job status and enriched data. Maximum length: 255
__zia_org_enrichment[].message	string	Required within parent	Provides a message that describes the outcome of the scheduling request. Maximum length: 255
__zia_org_enrichment[].status	string	Required within parent	Indicates whether the scheduling request succeeded. Possible values: success - The enrichment job was successfully accepted and queued. Known values: success

Policy, approvals and errors

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