更新说明
目的
要更新现有笔记。
端点
- PUT /Notes
- PUT /Notes/{note_id}
- PUT /{module_API_name}/{record_ID}/Notes
请求详情
请求 URL
{api-domain}/crm/{version}/Notes
要更新指定的备注:
{api-domain}/crm/{version}/Notes/{note_id}
要更新某条记录的备注:
{api-domain}/crm/{version}/{module_api_name}/{record_id}/Notes
支持的模块
潜在客户,Account,联系人,交易,营销活动,任务,案例,事件,电话,解决方案,产品,Vendors,价目表,报价,Sales Orders,采购Orders,Invoices,预约,服务和自定义
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
scope=ZohoCRM.modules.ALL
(或)
scope=ZohoCRM.modules.{module_name}.{operation_type}
(以及)
scope=ZohoCRM.modules.notes.{operation_type}
可能的模块名称
线索、客户账户、联系人、交易、活动、任务、事件、通话、案件、事件、通话、解决方案、产品、供应商、价格目录、报价单、销售订单、采购订单、发票、预约、服务以及自定义
可能的操作类型
ALL - 完全访问笔记
WRITE - Edit笔记数据
Update - Update笔记数据
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Notes/4150868000002975099"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@updatenote.json"
-X PUTCopiednote1 = Map();
note1.put("Note_Title", "Contacted");
note1.put("Note_Content", "Tracking done. Happy with the customer");
dataList = List();
dataList.add(note1);
params = Map();
params.put("data", dataList);
response = invokeurl
[
url :"https://www.zohoapis.com/crm/v8/Leads/692969000000981055/Notes/692969000000994147"
type :PUT
parameters: params.toString()
connection:"crm_oauth_connection"
];
info response;在请求中,"@updatenote.json" 包含示例输入数据。
请求 JSON 键
- Note_Title字符串,可选
指定笔记更新后的标题。
- Note_Content字符串,可选
指定笔记更新后的内容。
注意
- 您只能在输入中使用字段 API 名称。您可以从字段元数据 API(每个字段的键“api_name”的值)获取字段 API 名称。
- 每次 API 调用最多可更新100 条笔记。
- 您只能更新笔记的两个字段:Note_Title 和 Note_Content。您不能更新以下只读字段的值:Owner、Modified_Time、Created_Time、Modified_By 和 Created_By。
示例输入
Copied{
"data": [
{
"Note_Title": "Contacted",
"Note_Content": "Tracking done. Happy with the customer"
}
]
}在输入中,指定备注模块的字段 API 名称以及相应的值。
可能的错误
- INVALID_MODULEHTTP 400
提供的模块名称似乎无效
解决方法:您指定了无效的模块名称,或没有标签权限,或者该模块已从可用模块中移除。请指定有效的模块 API 名称。 - INVALID_MODULE HTTP 400
所提供的模块在 API 中不受支持
解决方法:当前 API 不支持像 Documents 和 Projects 这样的模块。(一旦这些模块被支持后,将不会再显示此错误。)请指定一个有效的模块 API 名称。 - INVALID_URL_PATTERN HTTP 404
请检查您尝试访问的URL是否正确
解决方法:请求的URL不正确。请指定有效的请求URL。请参考上面的请求URL部分。 - OAUTH_SCOPE_MISMATCH HTTP 401
未授权
解决方法: 客户端没有 ZohoCRM.modules.notes.UPDATE 权限。请创建具有有效权限的新客户端。详见上方的权限说明部分。 - NO_PERMISSION HTTP 403
没有权限更新备注详情
解决方法:用户没有权限更新备注数据。请联系系统管理员。 - INTERNAL_ERROR HTTP 500
服务器内部错误
解决方法:服务器出现意外且未处理的异常。请联系支持团队。 - INVALID_REQUEST_METHOD HTTP 400
HTTP请求方法类型无效
解决方法: 您为API URL指定了无效的HTTP请求方法。请指定一个有效的请求方法。请参考上方的端点部分。 - AUTHORIZATION_FAILED HTTP 400
用户没有足够的权限来更新备注
解决方法:用户没有权限更新备注数据。请联系您的系统管理员。 - INVALID_DATA HTTP 400
提供的相关ID似乎无效
解决方法:您指定了错误的相关记录ID。请指定有效的记录ID。请参考获取相关记录 API以获取有效的记录ID。 - MANDATORY_NOT_FOUND HTTP 400
未找到必填字段
解决方法: 您在输入中未指定一个或多个必填字段。请参考 字段元数据 API 以了解必填字段。
示例响应
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"created_time": "2016-07-05T17:13:24+05:30",
"modified_time": "2016-08-08T11:28:41+05:30",
"modified_by": {
"name": "Patricia Boyle",
"id": "4108880000086001"
},
"id": "410888000000643123",
"created_by": {
"name": "Patricia Boyle",
"id": "4108880000086001"
}
},
"message": "record updated",
"status": "success"
}
]
}