插入子表单数据
目的
在模块中插入带有子表单的新记录。
端点
- POST /{module_API_name}
请求详情
请求 URL
{api-domain}/crm/{version}/{module_API_name}
支持的模块
潜在客户,Account,联系人,交易,活动,案例,解决方案,产品,Vendors,报价,Sales Orders,采购Orders,Invoices和自定义。
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.modules.{module_name}.{operation_type}
可能的模块名称
线索、账户、联系人、交易、活动、案例、解决方案、产品、供应商、报价、销售订单、采购订单、发票和自定义。
可能的操作类型
全部 - 完全访问记录
写入 - 在模块中创建、更新和删除记录
创建 - 在模块中创建记录
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Leads"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@newlead.json"
-X POSTCopiedLanguagesData = List();
LanguagesData.add({"Proficiency": "Native","Languages_Known": "English"});
LanguagesData.add({"Proficiency": "Professional","Languages_Known": "French"});
LeadData = Map();
LeadData.put("Last_Name", "Contact_test");
LeadData.put("Email", "contact_test@xyz.com");
LeadData.put("Company", "Test");
LeadData.put("Languages", LanguagesData);
LeadData.put("Availability", [{"Weekends":"false","Weekdays":"true"}]);
LeadDataList = List();
LeadDataList.add(LeadData);
paramsMap = Map();
paramsMap.put("data", LeadDataList);
response = invokeurl
[
url: "https://www.zohoapis.com/crm/v8/Leads"
type: POST
parameters: paramsMap.toString()
connection:"crm_oauth_connection"
];
info response;在请求中,@newlead.json 包含示例输入数据。
注意
要向多个子表单添加数据,请按以下格式输入。
{ “data”: [ { .... Subform_1_API_name: [ { sub_form_data }, ], ... }, { .... Subform_2_API_name: [ { sub_form_data }, ], ... } ] }- 您可以使用模块 API和字段元数据 API分别获取子表单模块及其字段的 API 名称。
- 一个子表单最多可以有五个聚合自定义字段。
- Edit版本支持和限制:
- 企业版和Zoho One - 每个模块最多两个子表单。每条记录的子表单最多可以有 100 条子表单记录。
- 终极版和CRM Plus - 每个模块最多五个子表单。每条记录的子表单最多可以有 100 条子表单记录。
示例输入
Copied{
"data": [
{
"Last_Name": "Contact_test",
"Email": "contact_test@xyz.com",
"Languages": [
{
"Proficiency": "Native",
"Languages_Known": "English"
},
{
"Proficiency": "Professional",
"Languages_Known": "French"
}
],
"Availability":[
{
"Weekends":false,
"Weekdays":true
}]
}
]
}这里,“语言”和“可用性”是潜在客户模块中的两个子表单。“熟练程度”和“已知语言”是语言子表单中的自定义选择列表。“周末”和“工作日”是可用性子表单中的布尔字段。
可能的错误
- INVALID_MODULEHTTP 400
您指定了无效的模块 API 名称,或者没有标签权限,或者该模块已从可用模块列表中移除。
解决方法:使用模块 API获取模块的 API 名称。如果您没有标签权限或模块已被移除,请联系您的系统管理员。 - INVALID_MODULEHTTP 400
给定的模块在API中不受支持。
解决方案:目前,诸如文档和项目等模块在API中不受支持。一旦这些模块得到支持,此错误将不会显示。 - INVALID_DATAHTTP 400
您提供了不正确的输入。
解决方法:请指定有效的输入。请参阅示例输入部分以获取示例。 - MANDATORY_NOT_FOUNDHTTP 400
您在输入中未包含一个或多个必填字段。
解决方法:请参考字段元数据 API以了解该模块中的必填字段。 - AUTHORIZATION_FAILEDHTTP 400
您没有足够的权限添加子表单或模块记录。
解决方案:请联系您的系统管理员。 - INVALID_REQUEST_METHODHTTP 400
请求方法不正确。
解决方法:使用 HTTP POST 方法来进行此 API 调用。任何其他请求方法都会导致此错误。 - AUTHENTICATION_FAILUREHTTP 401
您未使用有效的访问令牌对API调用进行身份验证。
解决方法:在请求头中包含有效的访问令牌以对API调用进行身份验证。 - OAUTH_SCOPE_MISMATCHHTTP 401
您用于进行此 API 调用的访问令牌没有所需的范围。
解决方案:生成一个具有范围 ZohoCRM.modules.{module_name}.{operation_type} 的新访问令牌。有关详细信息,请参阅可能的模块名称和可能的操作类型部分。 - NO_PERMISSIONHTTP 403
您没有权限向子表单添加记录。
解决方法:请联系您的系统管理员。 - INVALID_URL_PATTERNHTTP 404
请求的URL不正确。
解决方法:请指定一个有效的请求URL。请参阅请求URL部分以获取正确的URL。 - INTERNAL_ERRORHTTP 500
服务器中出现意外且未处理的异常。
解决方法:请联系支持团队,邮箱:support@zohocrm.com。
示例响应
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2019-04-23T16:57:01+05:30",
"Modified_By": {
"name": "Patricia Boyle",
"id": "554023000000235011"
},
"Created_Time": "2019-04-23T16:57:01+05:30",
"id": "554023000000480721",
"Created_By": {
"name": "Patricia Boyle",
"id": "554023000000235011"
}
},
"message": "record added",
"status": "success"
}
]
}