记录克隆
目的
在模块中克隆记录。
端点
- POST /{module_api_name}/{record_id}/actions/clone
请求详情
请求 URL
{api-domain}/crm/{version}/{module_api_name}/{record_id}/actions/clone
支持的模块
潜在客户,Account,联系人,交易,活动,任务,案例,会议,电话,解决方案,产品,Vendors,价格表,报价单,Sales Orders,采购Orders,Invoices,预约,重新安排的预约历史,服务和自定义。
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
scope = ZohoCRM.modules.ALL
或
scope = ZohoCRM.modules.{module_name}.CREATE
可能的模块名称
线索、账户、联系人、交易、活动、任务、案例、事件、电话、解决方案、产品、供应商、价格表、报价单、销售订单、采购订单、发票、预约、预约重新安排历史、服务、备注和自定义。
示例请求
Copied"https://www.zohoapis.com/crm/v8/Leads/5725767000002529010/actions/clone"
-X POST
-d "input.json"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxd"
有关输入JSON键的详细信息,请参阅Insert记录API。
输入 JSON 键
- skip_feature_execution JSON array, optional
默认情况下,如果为模块配置了Cadence,当您通过API克隆记录时,它将自动执行。此键允许您在记录克隆操作期间跳过Cadences功能的执行。指定"cadences"作为"name"键的值以跳过记录的Cadences执行。确保在请求中包含此键以及"data"键。"name"键支持的值是"cadences"。
笔记
- 默认情况下,当您克隆一条记录时,父记录的字段值也会被复制到克隆的记录中。如果您想修改某些字段或为某些字段添加值,请在输入主体中指定它们的字段 API 名称及其对应的值。请参阅Insert记录 API中的示例输入部分,了解如何向模块中的字段添加值。请注意,如果您不打算更改字段值,可以在 API 请求中省略输入主体。
- 模块中的子表单记录只能与其父记录一起克隆。有关更多信息,请参阅子表单 API。
- 输入中的必填字段不应为null。
- 在记录克隆过程中,将排除以下字段/属性:
- 字段类型:
- 文件上传
- 图片上传
- 字段:
- wizard
- data_processing_basis_details (如果启用了GDPR)
- 字段属性:
- 只读
- 外部
- $ 属性在克隆记录时将被省略。
- 字段类型:
- 在记录克隆过程中,将排除特定模块的字段:
- 事件模块:
- recurring_activity
- remind_at
- 服务模块:
- Status
- Unavailable_From
- Unavailable_Till
- 预约模块:
字段:Status,Reschedule_Count,Job_Sheet_Created__s 和 Job_Sheet_Section__s。
注意:只有“预约信息”部分及其字段会被克隆。
- 事件模块:
- Insert记录 API 中提到的 示例输入、示例响应 和 可能的错误 适用于 记录克隆 API。
示例输入
Copied{
"data": [
{
"Last_Name": "Patricia",
"Company": "Info Technology",
"Email": "patricia@mail.com",
// Modifying Subform records
"Project_Details": //API name of the subform
[
{
// Assigning new values to the Subform records
"Project_Name": "Mobile App Development for Productivity",
"Project_Type": "Mobile App Development",
"Expected_Budget": 50000,
"Status": "Negotiation in Process"
}
]
}
],
"skip_feature_execution": [
{
"name": "cadences"
}
]
}可能的错误
- INVALID_DATAHTTP 400
无效的数据或请求体
解决方法:请指定有效的输入或请求体。有关更多信息,请参阅Insert记录API。 - DUPLICATE_DATAHTTP 400
重复数据
解决方法: 唯一字段的值(例如:在潜在客户模块中的电话)应在整个模块中保持唯一。为唯一键分配唯一值。 - MANDATORY_NOT_FOUNDHTTP 400
缺少必填字段
解决方案: 您未指定一个或多个必填字段。请参阅每个模块中详细说明的系统定义的必填字段,详见Insert记录 API。 - INVALID_REQUEST_METHODHTTP 400
HTTP请求方法类型无效
解决方案:您指定了一个无效的HTTP方法来访问API URL。
请指定一个有效的请求方法。请参阅上面的端点部分。 - OAUTH_SCOPE_MISMATCHHTTP 401
未经授权
解决方法:客户端没有克隆记录的有效范围。请创建一个具有所需范围的新令牌。请参阅上面的范围部分。 - Authentication_FAILUREHTTP 401
Authentication 失败
解决方法: 在API调用的请求头中传递访问令牌。 - NO_PERMISSIONHTTP 403
没有权限克隆记录
解决方法:联系管理员。 - INVALID_URL_PATTERNHTTP 404
请检查尝试访问的URL是否正确
解决方案: 请求的URL不正确。请指定一个有效的请求URL。请参阅上面的请求URL部分。 - INTERNAL_ERRORHTTP 500
内部服务器错误
解决方案:服务器中出现意外且未处理的异常。请联系支持团队。
示例响应
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2024-06-05T04:28:30-07:00",
"Modified_By": {
"name": "Patricia Boyle",
"id": "5725767000000411001"
},
"Created_Time": "2024-06-05T04:28:30-07:00",
"id": "5725767000002954096",
"Created_By": {
"name": "Patricia Boyle",
"id": "5725767000000411001"
},
"$approval_state": "approved"
},
"message": "record added",
"status": "success"
}
]
}