更新子表单数据
目的
在模块中使用子表单更新记录。
端点
- PUT /{module_API_name}
请求详情
请求URL
{api-domain}/crm/{version}/{module_API_name}
支持的模块
线索、Account、联系人、交易、市场活动、案例、解决方案、产品、Vendors、报价单、SalesOrders、采购Orders、Invoices以及自定义模块。
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
scope=ZohoCRM.modules.{module_name}.{operation_type}
可能的模块名称
线索、账户、联系人、交易、活动、案例、解决方案、产品、供应商、报价、销售订单、采购订单、发票以及自定义。
可能的操作类型
全部 - 对记录的完全访问权限
写入 - 创建、Update 和删除模块中的记录
Update - Update模块中的记录
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Contacts"
-X PUT
-d "@updatecontact.json"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Copieddata1 = Map();
data1.put("id", "692969000000983046");
data1.put("Languages", [{"id":"692969000000983047"},{"id":"692969000000983048","Proficiency":"Native","Languages_Known":"Korean"}]);
dataList = List();
dataList.add(data1);
param = Map();
param.put("data", dataList);
response = invokeurl
[
url: "https://www.zohoapis.com/crm/v8/Leads"
type: PUT
parameters: param.toString()
connection:"crm_oauth_connection"
];
info response;在请求中,@updatecontact.json 包含示例输入数据。
注意
要更新多个子表单,请按照以下格式输入。
{ “data”: [ { .... 子表单_1_API_名称: [ { 子表单数据 }, ], ... }, { .... 子表单_2_API_名称: [ { 子表单数据 }, ], ... } ] }- 您可以使用 模块 API 和 字段元数据 API 分别获取子表单模块及其字段的 API 名称。
- 您必须在请求URL或输入正文中指定记录ID。
- 当您更新现有子表单记录时,必须在子表单的 JSON 数组中包含该子表单记录的ID。您可以使用 获取记录API,通过子表单的API名称来获取子表单记录的ID。例如:{api-domain}/crm/v8/Secondary?fields=Secondary_Email。这里,Secondary 是子表单的API名称。
请参阅示例输入以了解详情。 - From V3开始,当您通过添加新记录来更新子表单时,新记录会被追加到子表单中,原有记录不会受到影响。
- 当你为子表单传递一个空的JSON数组时,它会删除该子表单中的所有记录。
- 要删除特定的子表单记录,请指定该子表单记录的ID,并使用键_delete,其值为"null"。请参考示例输入部分获取示例。
- 删除父记录时,也会删除所有子表单记录。
用于更新现有子表单记录的示例输入
Copied{
"data": [
{
"id": "554023000000480721",//contact id
"Languages": [
{
"id":"554023000000480787",//id of the subform record
"Proficiency": "Native",//data to be updated
"Languages_Known": "French"//data to be updated
}
],
"Availability": [
{
"id": "554023000000480728",//id of the subform record
"Weekdays": false//data to be updated
}
]
}
]
}添加新子表单记录的示例输入
Copied{
"data": [
{
"id": "554023000000480721",//contact id
"Languages": [
{
"Proficiency": "Pofessional"
}
]
}
]
}用于删除子表单记录的示例输入
Copied{
"data": [
{
"Languages": [
{
"id": "554023000000480721", //The ID of the subform record you want to delete
"_delete": null
}
]
}
]
}可能的错误
- INVALID_MODULEHTTP 400
您指定了无效的模块 API 名称,或者没有模块的标签权限,或者该模块已从可用模块列表中移除。
解决方法: 使用 模块 API 获取模块的 API 名称。如果您没有标签权限或该模块已被移除,请联系您的系统管理员。 - INVALID_MODULEHTTP 400
所提供的模块在 API 中不被支持。
解决方法: 目前,Documents 和 Projects 等模块在 API 中不被支持。一旦这些模块被支持后,该错误将不会显示。 - INVALID_DATAHTTP 400
您提供了错误的输入。
解决方法:请提供有效的输入。可参考示例输入部分获取范例。 - MANDATORY_NOT_FOUNDHTTP 400
您未在输入中包含一个或多个必填字段。
解决方法:请参考字段元数据 API,了解该模块中的必填字段。 - AUTHORIZATION_FAILEDHTTP 400
您没有足够的权限来更新子表单或模块记录。
解决方法:请联系您的系统管理员。 - INVALID_REQUEST_METHODHTTP 400
请求方法不正确。
解决方法:请使用 HTTP PUT 方法调用此 API。使用其他请求方法将会导致此错误。 - AUTHENTICATION_FAILUREHTTP 401
您未使用有效的访问令牌对 API 调用进行身份验证。
解决方案: 在请求头中包含有效的访问令牌,以对 API 调用进行身份验证。 - OAUTH_SCOPE_MISMATCHHTTP 401
您用于此 API 调用的访问令牌不具备所需的权限范围(scope)。
解决方法: 生成一个包含 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-23T17:31:02+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 updated",
"status": "success"
}
]
}