组织丰富
目的
Zia会根据互联网上可用的数据,在Zoho CRM中丰富数据。当您启用数据丰富功能时,某些字段会作为触发器,根据您设置的映射关系,丰富其他字段的数据。例如,如果您将组织名称设置为触发字段之一,那么在创建或更新记录时向该字段输入数据时,其他字段会基于此被丰富。
使用此API可在组织级别初始化或触发数据丰富功能。此API会安排一个任务。
端点
- POST /__zia_org_enrichment
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/__zia_org_enrichment?module=Accounts"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"
-X POST请求 JSON
- enrich_based_onJSON 对象
你希望基于其值来触发丰富的字段的详细信息。请注意,输入中必须至少提供以下值之一。基于这些值,Zia 会在网络上查找相关信息,并根据丰富配置丰富相关字段。请注意,这些键的值必须至少有三个字符且只能为英文。
- namestring
组织的名称。
- emailstring
组织的电子邮件地址。
- websitestring
组织的网站。
示例输入
Copied{
"__zia_org_enrichment": [
{
"enrich_based_on": {
"name": "zoho",
"email": "sales@zohocorp.com",
"website": "www.zoho.com"
}
}
]
}响应 JSON
- codestring
表示 API 状态的代码。"SCHEDULED" 意味着任务已被安排。
- detailsJSON 对象
计划任务的唯一 ID。请在 获取组织配置 API 中使用此 ID 以获取增强的详细信息。
- 状态布尔值
增强的状态。
可能的错误
- INVALID_DATAHTTP 400
- “name”、“email” 或 “website” 键的 API 名称不正确。
解决方法: 输入正确的键名称。 - 模块的 API 名称不正确。
解决方法: 输入正确的模块 API 名称。使用 获取模块 API 获取模块的 API 名称。 - 记录 ID 无效。
解决方法: 使用 获取记录 API 来获取模块中记录的 ID。 - “email”、“name” 和 “website” 键的值长度少于三个字符。
解决方法: 这些键的值必须至少三个字符。 - 您已用其他语言为 “email”、“name” 或 “website” 键指定了值。
解决方法: 这些键的值必须为英文。 - 输入中键的数据类型不是字符串。
解决方法: 输入键的值必须为字符串类型。
- “name”、“email” 或 “website” 键的 API 名称不正确。
- MANDATORY_NOT_FOUNDHTTP 400
您未在输入中指定键 “enrich_based_on”。
解决方法:“enrich_based_on” 是必填输入键。 - EXPECTED_FIELD_MISSINGHTTP 400
您未在 "enrich_based_on" JSON 对象中指定任何关键字段。
解决方法:请在 "enrich_based_on" JSON 对象中至少指定 "name"、"email" 或 "website" 其中之一。 - LIMIT_EXCEEDEDHTTP 400
您已为您的组织创建了超过允许数量的增强项。
解决方法: 增强项的数量限制取决于用户数量。对于企业Edit,限制为用户数 x 500,而对于旗舰版,则为用户数 x 2000,两种版本的最大限制都是 50,000。如需了解更多详情,请参阅各Edit本ZohoCRM功能列表。 - REQUIRED_PARAM_MISSINGHTTP 400
您在请求中未指定 "module" 参数。
解决方法: "module" 是请求中必需的参数。 - NOT_ALLOWEDHTTP 400
“email” 在配置中未映射。
解决方法:您只能基于增强配置中的字段进行字段丰富。 - FEATURE_NOT_ENABLEDHTTP 400
您的账户未启用数据丰富功能。
解决方法:请启用数据丰富功能或联系您的系统管理员。 - FEATURE_NOT_SUPPORTEDHTTP 400
您的CRM版本不支持数据丰富功能。
解决方法: 数据丰富功能仅适用于CRM的企业版和旗舰版。请升级您的版本或联系 support@zohoCRM.com。 - OAUTH_SCOPE_MISMATCHHTTP 401
您没有访问此 API 的正确权限范围。
解决方法:请创建一个包含“权限范围”部分中提到的权限的新令牌,然后再次尝试此 API。 - NO_PERMISSIONHTTP 403
您没有权限访问此功能。
解决方法:请联系您的系统管理员。 - INTERNAL_SERVER_ERRORHTTP 500
服务器中未处理和意外的异常。
解决方法:请联系 support@zohocrm.com 寻求帮助。
示例回复
Copied{
"__zia_org_enrichment": [
{
"code": "SCHEDULED",
"details": {
"id": "111112000000071191"
},
"message": "Org Enrichment scheduled successfully",
"status": "success"
}
]
}