备注API
备注是提供关于联系人、客户、商机或任务的一些附加信息。您可以在大多数模块中找到备注部分。因此,通过备注API,您可以创建、删除或更新备注。您可以对单个或多个备注执行操作。
获取备注
目的
用来获取备注列表。
请求URL
https://www.zohoapis.com.cn/crm/v2/Notes
请求方法
GET
范围
scope=ZohoCRM.modules.notes.{operation_type}
| 可能的操作类型 |
|---|
| ALL - 完全访问备注 READ - 获取备注数据 |
参数
| 参数名称 | 数据类型 | 描述 |
|---|---|---|
| page (可选) | 整型 | 从相关页面获取记录列表。默认值是1。 |
| per_page (可选) | 整型 | 获取每页可用记录的列表。默认值是200。 |
备注:
page和per_page参数用于根据它们在CRM中的位置获取记录。假设用户必须获取400条记录。一个API调用最多可以获得200条记录。因此,对于第200条以上的记录,无法获取。通过使用page (1, 2, 3 和 4) 和 per_page (100) 参数,用户可以使用4个API调用获取所有400条记录。
示例请求
curl "https://www.zohoapis.com.cn/crm/v2/Notes"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf" 示例响应
{
"data": [
{
"Owner": {
"name": "Patricia Boyle",
"id": "410888000000086001"
},
"$se_module": "Leads",
"$approval": {
"delegate": false,
"approve": false,
"reject": false
},
"Modified_By": {
"name": "Patricia Boyle",
"id": "410888000000086001"
},
"Modified_Time": "2016-09-15T18:03:09+05:30",
"Created_Time": "2016-09-15T18:03:09+05:30",
"$followed": false,
"Parent_Id": {
"name": null,
"id": "410888000000698006"
},
"id": "410888000000734003",
"Created_By": {
"name": "Patricia Boyle",
"id": "410888000000086001"
},
"Note_Title": "",
"Note_Content": "Demo scheduled for this Lead"
},
{
"Owner": {
"name": "Patricia Boyle",
"id": "410888000000086001"
},
"$se_module": "Leads",
"$approval": {
"delegate": false,
"approve": false,
"reject": false
},
"Modified_By": {
"name": "Patricia Boyle",
"id": "410888000000086001"
},
"Modified_Time": "2016-07-05T16:43:36+05:30",
"Created_Time": "2016-07-05T16:43:36+05:30",
"$followed": false,
"Parent_Id": {
"name": null,
"id": "410888000000572160"
},
"id": "410888000000643112",
"Created_By": {
"name": "Patricia Boyle",
"id": "410888000000086001"
},
"Note_Title": "Demo",
"Note_Content": "This is sample content to test Zoho CRM API"
}
],
"info": {
"per_page": 200,
"count": 200,
"page": 1,
"more_records": true
}
}