Zia enrichment configurations in CRM modules. Published by Zoho in its first-party OpenAPI 3.1.0 repository github.com/zoho/crm-oas; 1 operation(s).
{
"openapi": "3.1.0",
"info": {
"title": "Zia Enrichment Configuration API",
"description": "Zia enrichment configurations in CRM modules.",
"version": "8"
},
"servers": [
{
"url": "https://zohoapis.{dc}/crm/{version}",
"description": "Zoho API Base URL",
"variables": {
"dc": {
"enum": [
"com",
"eu",
"in",
"ca",
"au",
"sa",
"ae"
],
"default": "com"
},
"version": {
"default": "v8",
"description": "API version"
}
}
}
],
"paths": {
"/settings/zia/data_enrichment": {
"get": {
"operationId": "getZiaEnrichmentConfiguration",
"summary": "get Zia Enrichment Configuration for a specific module",
"description": "get Zia Enrichment Configuration for a specific module",
"responses": {
"200": {
"description": "200 Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data_enrichment": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 19,
"description": "Id field."
},
"type": {
"type": "string",
"maxLength": 255,
"description": "Type field."
},
"module": {
"$ref": "#/components/schemas/Module"
},
"status": {
"type": "boolean",
"description": "Status field."
},
"input_data_field_mapping": {
"$ref": "#/components/schemas/FieldMappingForRead"
},
"created_time": {
"type": "string",
"maxLength": 255,
"description": "Created time field."
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 19,
"description": "Id field."
},
"name": {
"type": "string",
"maxLength": 255,
"description": "Name field."
}
},
"required": [
"id",
"name"
],
"additionalProperties": false,
"description": "Created by field."
},
"modified_time": {
"type": "string",
"maxLength": 255,
"description": "Modified time field."
},
"modified_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 19,
"description": "Id field."
},
"name": {
"type": "string",
"maxLength": 255,
"description": "Name field."
}
},
"required": [
"id",
"name"
],
"additionalProperties": false,
"description": "Modified by field."
}
},
"required": [
"id",
"type",
"module",
"status",
"input_data_field_mapping",
"created_time",
"created_by",
"modified_time",
"modified_by"
],
"additionalProperties": false,
"description": "Items field."
},
"maxItems": 50,
"description": "Data enrichment field."
}
},
"required": [
"data_enrichment"
],
"description": "data_enrichment data successfully fetched.",
"additionalProperties": false
}
}
}
},
"204": {
"description": "No Content"
},
"400": {
"description": "400 Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"FEATURE_NOT_ENABLED",
"FEATURE_NOT_SUPPORTED"
],
"description": "Code field."
},
"details": {
"type": "object",
"properties": {},
"additionalProperties": false,
"description": "Details field."
},
"message": {
"type": "string",
"maxLength": 255,
"description": "Message field."
},
"status": {
"type": "string",
"maxLength": 255,
"description": "Status field."
}
},
"required": [
"code",
"details",
"message",
"status"
],
"description": "Error response when feature is not enabled or not supported.",
"additionalProperties": false
}
}
}
},
"403": {
"description": "403 response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"maxLength": 255,
"description": "Code field."
},
"details": {
"type": "object",
"properties": {
"permissions": {
"type": "array",
"items": {
"type": "string",
"maxLength": 255,
"description": "Items field."
},
"maxItems": 50,
"description": "Permissions field."
}
},
"required": [
"permissions"
],
"additionalProperties": false,
"description": "Details field."
},
"message": {
"type": "string",
"maxLength": 255,
"description": "Message field."
},
"status": {
"type": "string",
"maxLength": 255,
"description": "Status field."
}
},
"required": [
"code",
"details",
"message",
"status"
],
"description": "Error response when a feature is accessed without permission",
"additionalProperties": false
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.zia.enrichment"
]
}
]
}
}
},
"components": {
"securitySchemes": {
"iam-oauth2-schema": {
"type": "oauth2",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
"tokenUrl": "https://accounts.zoho.com/oauth/v2/token",
"refreshUrl": "https://accounts.zoho.com/oauth/v2/token",
"scopes": {
"ZohoCRM.zia.enrichment": "Allows managing Zia data enrichment configurations in CRM"
}
}
}
}
},
"schemas": {
"FieldMappingForRead": {
"type": "array",
"items": {
"type": "object",
"properties": {
"enrich_field": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "Name field."
},
"display_label": {
"type": "string",
"maxLength": 255,
"description": "Display label field."
}
},
"required": [
"name",
"display_label"
],
"additionalProperties": false,
"description": "Enrich field field."
},
"crm_field": {
"description": "Crm field object",
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 19,
"description": "Id field."
},
"api_name": {
"type": "string",
"maxLength": 255,
"description": "Api name field."
},
"name": {
"type": "string",
"maxLength": 255,
"description": "Name field."
}
},
"required": [
"id",
"api_name"
],
"additionalProperties": false,
"description": "Oneof field."
},
{
"type": "null",
"description": "Oneof field."
}
]
}
},
"required": [
"enrich_field",
"crm_field"
],
"additionalProperties": false,
"description": "Items field."
},
"maxItems": 50,
"description": "Fieldmappingforread field."
},
"Module": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 19,
"description": "Id field."
},
"api_name": {
"type": "string",
"maxLength": 255,
"description": "Api name field."
}
},
"required": [
"id",
"api_name"
],
"additionalProperties": false,
"description": "Module field."
}
}
}
}