Zoho: Zia enrichment schemas

← Zia enrichment operations · All 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 input data field mapping

Field	Type	Presence	Description and constraints
$	array	Root	Array of field mappings for write operations. Maximum items: 50
$[]	object	Each item	Field mapping item for write operations. Additional keys: not allowed
$[].crm_field	JSON	Required within parent	CRM field object. Provide both ID and API name. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to get CRM field IDs and API names.
$[].crm_field (anyOf 1)	object	Alternative	CRM field object with ID and API 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 2)	null	Alternative	Null value for CRM field (no mapping).
$[].enrich_field	object	Required within parent	Zia enrichment field metadata. Additional keys: not allowed
$[].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