更新蓝图详情
目的
一次仅更新一个转换。如果记录未处于转换中、transition_id 错误、field_value 数据类型不匹配或字段验证失败,则会抛出错误。
端点
- PUT /{module_API_name}/{record_ID}/actions/blueprint
请求详情
请求 URL
{api-domain}/crm/{version}/{module_api_name}/{record_id}/actions/blueprint
支持的模块
潜在客户、Account、联系人、交易、活动、任务、案例、事件、会议、解决方案、产品、Vendors、价格表、报价单、Sales订单、采购订单、Invoices、备注以及自定义
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
scope=ZohoCRM.modules.ALL
(或)
scope=ZohoCRM.modules.{module_name}.{operation_type}
可能的模块名称
线索、客户账户、联系人、交易、活动、任务、案件、事件、会议、解决方案、产品、供应商、价格表、报价单、销售订单、采购订单、发票、备注以及自定义
可能的操作类型
ALL - 完全访问记录
WRITE - Edit模块中的记录
UPDATE - Update模块中的记录
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Leads/3652397000003931001/actions/blueprint"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@blueprint1.json"
-X PUTCopieddataMap = Map();
dataMap.put("Notes", "Updated via blueprint");
blueprint1 = Map();
blueprint1.put("transition_id", "692969000000981130");
blueprint1.put("data", dataMap);
blueprintList = List();
blueprintList.add(blueprint1);
param = Map();
param.put("blueprint", blueprintList);
response = invokeurl
[
url: "https://www.zohoapis.com/crm/v8/Leads/692969000000983046/actions/blueprint"
type: PUT
parameters: param.toString()
connection:"crm_oauth_connection"
];
info response;在请求中,“@blueprint1.json”包含示例输入数据。
注意
- 在“相关列表”示例中,键名 "Tasks" 是与用于流程蓝图转换的记录相关的列表名称。
- 该 API 的相关列表支持取决于用于蓝图转换的记录所属的模块。
- 如果输入字段的数量未达到要求,响应中的 "message" 将显示为“转换部分保存”。
- 在并行流转中,一个流转可以有多个父流转,只有在其所有子流转完成后,父流转才会自动完成。我们将在即将发布的版本中引入此功能。详情请参阅本公告。
示例输入
Copied示例输入:上传附件、备注、多选用户查找、多选查找和小部件到蓝图
{
"blueprint": [
{
"transition_id": "3652397000003921127",
"data": {
"Attachments": [
{
"$file_id": [
"59cf260313b690xxx9d623a",
"59cf260xxxx624d"
]
},
{
"$link_url": "www.zoho.com"
}
],
"Phone": 8940372937,
"Notes": "Updated via blueprint",
"Listings": [
{
"Interested_Listings": {
"id": "3652397000001978005"
}
},
{
"Interested_Listings": {
"id": "3652397000001978016"
}
}
],
"Multi_user": [
{
"Multi_user": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
}
},
{
"Multi_user": {
"id": "3652397000000281001"
}
}
],
"widget": {
"name": "widget",
"id": "3652397000003937009"
}
},
"process_info": {
"escalation": {
"days": 1,
"status": "overdue"
}
},
"transitions": [
{
"type": "manual",
"next_transitions": [
{
"name": "Call Later",
"id": "3652397000003921103",
"type": "manual"
},
{
"name": "Product Brief",
"id": "3652397000003921135",
"type": "manual"
}
]
}
]
}
]
}
Sample Input: To handle parent module fields during transition
{
"blueprint": [
{
"transition_id": "2000000031536",
"data": {
"Lookup_2": {
"phone": "123458939",
"id": "2000000048165"
}
}
}
]
}
Sample Input: To update checklist information
{
"blueprint": [
{
"transition_id": "1000000034304",
"data": {
"CheckLists": [
{
"list 1": true
},
{
"list 2": false
},
{
"list 3": true
},
{
"list 4": true
}
]
}
}
]
}
Sample Input: To update related list information
{
"blueprint": [
{
"transition_id": "2000000031536",
"data": {
"Tasks": {
"Subject": "Event"
}
}
}
]
}可能的错误
- INVALID_MODULEHTTP 400
提供的模块名称似乎无效
解决方法:您指定的模块名称无效、没有标签权限,或者该模块已从可用模块中移除。请指定一个有效的模块 API 名称。 - INVALID_MODULEHTTP 400
所提供的模块在 API 中不受支持
解决方法: 当前 API 不支持如“文档”和“项目”等模块。(一旦这些模块被支持,该错误将不会显示。)请指定有效的模块 API 名称。 - RECORD_LOCKEDHTTP 400
无法执行此操作,因为记录已被锁定。
解决方法:请等待记录解锁后再尝试。 - INVALID_URL_PATTERNHTTP 404
请检查尝试访问的URL是否正确
解决方法:指定的请求URL不正确。请指定一个有效的请求URL。请参考上方的请求URL部分。 - OAUTH_SCOPE_MISMATCHHTTP 401
未授权
解决方法:客户端没有ZohoCRM.modules.{module_name}.UPDATE的权限。请创建具有有效权限的新客户端。详见上方的权限范围部分。 - NO_PERMISSIONHTTP 403
无权更新记录
解决方案:用户没有权限更新蓝图数据。请联系您的系统管理员。 - INTERNAL_ERRORHTTP 500
服务器内部错误
解决方法: 服务器发生了意外且未处理的异常。请联系支持团队。 - INVALID_REQUEST_METHODHTTP 400
HTTP请求方法类型无效
解决方法:您为访问API URL 指定了一个无效的HTTP方法。请指定有效的请求方法。参考上方的端点部分。 - AUTHORIZATION_FAILEDHTTP 400
用户没有足够的权限来更新记录
解决方法:该用户没有权限更新蓝图数据,请联系系统管理员。 - INVALID_DATAHTTP 400
提供的ID似乎无效
解决方法:您指定了一个不正确的记录ID。请指定一个有效的记录ID。请参考获取记录 API以获取有效的记录ID。 - MANDATORY_NOT_FOUNDHTTP 400
缺少必填参数
解决方法:您在输入中未指定一个或多个必填字段。请参阅 字段元数据 API 以了解必填字段。
示例回复
Copied{
"code": "SUCCESS",
"details": {},
"message": "transition updated successfully",
"status": "success"
}