Data Enrichment Fields Metadata
Purpose
Retrieve the list of supported enrichment fields and their corresponding Zoho CRM fields that can be used when creating a Data Enrichment configuration.
This API provides the available fields for the Organization-level enrichment.
Use this API to determine which enrichment fields are allowed and can be mapped to CRM fields during configuration setup.
Endpoints
- GET /settings/zia/data_enrichment
- GET /settings/zia/data_enrichment/{configuration_ID}
- GET /settings/zia/data_enrichment/allowed_field_mappings
Request Details
Request URLs
{api-domain}/crm/{version}/settings/zia/data_enrichment/allowed_field_mappings
Supported Modules
Leads, Contacts, Accounts, Vendors, and Custom
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
ZohoCRM.Zia.enrichment.ALL (or)
ZohoCRM.Zia.enrichment.READ
Parameters
- modulestring, mandatory
Specify the module for which you want to retrieve the allowed enrichment fields and corresponding CRM fields. Use the Get Modules Metadata API to retrieve module API names.
Supported modules: Leads, Contacts, Accounts, Vendors, and Custom. - typestring, mandatory
The type of enrichment.
Possible values:
organization - Organization-level enrichment
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/zia/data_enrichment/allowed_field_mappings?module=Leads&type=organization"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Response JSON Keys
Represents allowed_field_mappings JSON object that contains the list of enrichment fields and their corresponding Zoho CRM fields that are allowed for mapping.
- input_data_field_mappingJSON array
Represents the mapping of enrichment fields to Zoho CRM fields that act as input (trigger) fields.
These fields are used to trigger data enrichment. When you provide values in these CRM fields, Zia uses that input to fetch related data and populate other mapped fields.
Example: If Company is configured as an enrichment field in the Leads module, entering a value in the Company field will trigger enrichment of other fields based on the mapping.
Possible values:
Organization Name, Email, WebsiteYou can find the corresponding CRM fields that will be enriched in the output_data_field_mapping key.
- enrich_fieldJSON object
Represents the enrichment field details.
- name - Name of the enrichment field.
- display_label - Display label of the enrichment field.
Zia looks for data related to this field over the Internet.
- crm_fieldJSON array
Represents the CRM field mapped as the trigger.
- id - Unique ID of the CRM field
- api_name - API name of the CRM field
Providing input to this field triggers data enrichment in the mapped output fields.
- output_data_field_mappingJSON array
Represents the mapping of enrichment fields to Zoho CRM fields that will be updated with enriched data.
When values are entered in the fields specified in input_data_field_mapping, Zia retrieves relevant data and updates the CRM fields defined here.
- enrich_fieldJSON object
Represents the enrichment field details.
- name - Name of the enrichment field.
- display_label - Display label of the enrichment field.
Zia fetches data based on this field and enriches the mapped CRM field.
- crm_fieldJSON array
Represents the CRM field that will receive enriched data.
- id - Unique ID of the CRM field
- name - Field label
- api_name - API name of the CRM field
When enrichment is enabled and Zia finds data, these fields are automatically updated.
Possible Errors
- INVALID_DATAHTTP 400
- Invalid datatype for parameters
Resolution: Specify valid datatypes for the corresponding parameters. Refer to the Parameters section. - Invalid value for the type parameter
Resolution: Specify a valid value. Possible values: organization
- Invalid datatype for parameters
- NOT_SUPPORTEDHTTP 400
Unsupported module for data enrichment configuration
Resolution: Specify a supported module.
Supported modules: Leads, Contacts, Accounts, Vendors, and Custom modules. - REQUIRED_PARAM_MISSINGHTTP 400
Required parameters are missing
Resolution: Specify the required parameters with their corresponding values.
Required parameters: module, type. - NO_PERMISSIONHTTP 400
No permission to retrieve data enrichment fields metadata
Resolution: Contact your administrator to get the necessary permissions. - FEATURE_NOT_ENABLEDHTTP 400
Data enrichment feature is not enabled for your account
Resolution: Enable data enrichment feature or contact your system administrator. - FEATURE_NOT_SUPPORTEDHTTP 400
Data enrichment is not available for your edition of CRM
Resolution: Data enrichment is available only for the Enterprise and Ultimate editions of CRM. Upgrade your edition or contact support@zohocrm.com. - INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: You have specified an invalid HTTP method to access the API URL.
Specify a valid request method. Refer to the Endpoints section. - OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: The client does not have a valid scope to retrieve the allowed fields for data enrichment configuration mapping. Create a new token with valid scope. Refer to the Scope section. - AUTHENTICATION_FAILUREHTTP 401
Authentication failed
Resolution: Pass the access token in the request header of the API call. - INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL.Refer to the "Request URL" section. - INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in the server. Contact support team.
Sample Response
Copied{
"allowed_field_mappings": {
"input_data_field_mapping": [
{
"enrich_field": {
"display_label": "Organization Name",
"name": "org_name"
},
"crm_fields": [
{
"api_name": "Company",
"id": "5725767000000002591"
},
{
"api_name": "Designation",
"id": "5725767000000002597"
},
.
.
.
]
},
{
"enrich_field": {
"display_label": "Email",
"name": "email"
},
"crm_fields": [
{
"api_name": "Email",
"id": "5725767000000002599"
},
{
"api_name": "Secondary_Email",
"id": "5725767000000044003"
},
{
"api_name": "Your_Namea",
"id": "5725767000002475012"
}
]
},
{
"enrich_field": {
"display_label": "Website",
"name": "org_website"
},
"crm_fields": [
{
"api_name": "Website",
"id": "5725767000000002607"
}
]
}
],
"output_data_field_mapping": [
{
"enrich_field": {
"display_label": "Organization Name",
"name": "name"
},
"crm_fields": [
{
"api_name": "Company",
"id": "5725767000000002591"
},
{
"api_name": "First_Name",
"id": "5725767000000002593"
},
{
"api_name": "Last_Name",
"id": "5725767000000002595"
},
.
.
.
]
},
{
"enrich_field": {
"display_label": "Primary Email",
"name": "primary_email"
},
"crm_fields": [
{
"api_name": "Email",
"id": "5725767000000002599"
},
{
"api_name": "Secondary_Email",
"id": "5725767000000044003"
},
.
.
.
]
},
{
"enrich_field": {
"display_label": "Secondary Email",
"name": "secondary_email"
},
"crm_fields": [
{
"api_name": "Email",
"id": "5725767000000002599"
},
{
"api_name": "Secondary_Email",
"id": "5725767000000044003"
},
.
.
.
]
},
{
"enrich_field": {
"display_label": "Primary Contact Number",
"name": "primary_contact"
},
"crm_fields": [
{
"api_name": "Phone",
"id": "5725767000000002601"
},
{
"api_name": "Mobile",
"id": "5725767000000002605"
}
]
},
{
"enrich_field": {
"display_label": "Secondary Contact Number",
"name": "secondary_contact"
},
"crm_fields": [
{
"api_name": "Phone",
"id": "5725767000000002601"
},
{
"api_name": "Mobile",
"id": "5725767000000002605"
}
]
},
{
"enrich_field": {
"display_label": "Industries",
"name": "industries"
},
"crm_fields": [
{
"api_name": "Company",
"id": "5725767000000002591"
},
{
"api_name": "First_Name",
"id": "5725767000000002593"
},
{
"api_name": "Designation",
"id": "5725767000000002597"
},
.
.
.
]
},
.
.
.
]
}
}