创建笔记
目的
要添加新笔记。
端点
- POST /Notes
- POST /{module_api_name}/{record_id}/Notes
请求详情
请求 URL
{api-domain}/crm/{version}/Notes
要为特定记录添加备注:
{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 笔记数据
CREATE - 创建笔记数据
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Leads/1000000145990/Notes"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@newnote.json"
-X POSTCopiednote1 = Map();
note1.put("Note_Title",
"Contacted");
note1.put("Note_Content",
"Need to do further tracking");
note1.put("Parent_Id",
{
"module": {
"api_name": "Leads",
"id": "5725767000000002175"
},
"id": "6157809000012985001"
});
dataList = List();
dataList.add(note1);
params = Map();
params.put("data",dataList);
response = invokeurl
[
url : "https://www.zohoapis.com/crm/v8/Notes"
type :POST
parameters:params.toString()
connection: "crm"
];
info response;在请求中,"@newnote.json"包含示例输入数据。
请求 JSON 键
- Parent_IdJSON 对象,必填
包含父记录的详细信息。
- moduleJSON 对象,必填
表示所请求模块的详细信息。必须指定所请求模块的 API 名称 或 唯一 ID 之一。请参考 GET Modules API 获取详细信息。
- id字符串,必填
指定父记录的唯一 ID。请参考 GET Records API 获取有效的记录 ID。
- Note_Content字符串,必填
指定备注的内容。
注意
- 在输入中只能使用字段 API 名称。您可以从字段元数据 API获取字段 API 名称(每个字段键“api_name”的值)。
- 每次 API 调用最多可创建100 条备注。
示例输入
Copied{
"data": [
{
"Parent_Id": {
"module": {
"api_name": "Leads", //API name of the module
"id": "2423488000000000125" //module ID
},
"id": "2423488000000771297" //record ID
},
"Note_Content": "note content after edit"
}
]
}在输入中,请指定备注模块的字段 API 名称及其对应的值。
可能的错误
- INVALID_MODULEHTTP 400
提供的模块名称似乎无效
解决方案: 您指定了无效的模块名称,或者没有选项卡权限,或者该模块已从可用模块中移除。请指定有效的模块 API 名称。 - INVALID_MODULEHTTP 400
所提供的模块在 API 中不受支持
解决方案:当前 API 不支持 Documents 和 Projects 等模块。(一旦这些模块获得支持,就不会再显示此错误。)请指定有效的模块 API 名称。 - 无效_URL_模式HTTP 404
请检查尝试访问的URL是否正确
解决方法:所指定的请求URL不正确。请指定有效的请求URL。请参阅上面的请求URL部分。 - OAUTH_SCOPE_MISMATCHHTTP 401
未授权
解决方法: 客户端不具备ZohoCRM.modules.notes.CREATE 作用域。创建一个具有有效作用域的新客户端。请参阅上面的作用域部分。 - 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{
"data": [
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2023-12-18T18:48:25+05:30",
"Modified_By": {
"name": "Patricia",
"id": "2423488000000483001"
},
"Created_Time": "2023-12-18T18:48:25+05:30",
"id": "2423488000000776006",
"Created_By": {
"name": "Patricia",
"id": "2423488000000483001"
}
},
"message": "record added",
"status": "success"
}
]
}