标签 API
标签是帮助您根据记录的特征对其进行分类的关键词。标签帮助您整理数据,并在需要时轻松找到它们。
获取标签
目的
要显示您在Zoho CRM中可用的所有标签。
端点
- GET /settings/tags?module={module_API_name}
请求详情
请求 URL
{api-domain}/crm/{version}/settings/tags?module={module_API_name}
支持的模块
潜在客户,Account,联系人,交易,活动,任务,案例,事件,通话,解决方案,产品,Vendors,价格表,报价单,Sales Orders,采购Orders,Invoices,以及自定义模块。
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.settings.ALL
(或)
ZohoCRM.settings.tags.{operation_type}
可能的操作类型
全部 - 完全访问标签
读取 - 获取标签详情
参数
- module字符串,必填
指定模块的API名称,例如Leads,Account,Deals等。
- my_tags布尔值,可选
值为true时显示当前用户创建的标签名称。默认值为false。
Edit按区域创建标签
下表显示了按版本划分的标签创建限制和按记录划分的标签创建限制。
| Editions | 按模块创建标签 | 按记录创建标签 |
|---|---|---|
| 标准版 | 20 | 5 |
| 专业版 | 60 | 10 |
| 企业版 | 100 | 10 |
| 终极版 | 200 | 10 |
| Zoho One | 20 | 5 |
| CRM Plus | 200 | 10 |
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/tags?module=Leads"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/crm/v8/settings/tags?module=Leads"
type: GET
connection:"crm_oauth_connection"
];
info response;响应 JSON
- created_timestring
表示标签创建的日期和时间。
- modified_timestring
表示标签最后修改的日期和时间。
- namestring
表示当前标签的名称。
- modified_byJSON object
表示最后修改当前标签的用户的姓名和ID。
- idstring
表示当前标签的唯一ID。
- created_byJSON object
表示创建标签的用户的姓名和ID。
- colour_codestring
表示标签的十六进制颜色代码。
可能的错误
- INVALID_MODULEHTTP 400
给定的模块名称似乎无效
解决方法:您指定了一个无效的模块名称,或者没有标签权限,或者该模块可能已从可用模块中移除。请指定一个有效的模块 API 名称。使用 GET - 模块元数据 API 来检索模块 API 名称,或联系您的系统管理员。 - INVALID_MODULEHTTP 400
给定的模块不支持指定的API
解决方案:当前API不支持Documents和Projects等模块。(一旦这些模块被支持,此错误将不会显示)。请指定一个有效的模块API名称。使用GET - Module Metadata API来检索模块API名称或联系您的Admin。 - INVALID_REQUEST_METHODHTTP 400
HTTP请求方法类型无效
解决方案:您指定了一个无效的HTTP方法来访问API URL。请指定一个有效的请求方法。请参阅端点部分。 - AUTHORIZATION_FAILEDHTTP 400
用户没有足够的权限读取标签详情
解决方案:用户没有读取标签详情的权限。请联系系统管理员。 - REQUIRED_PARAM_MISSINGHTTP 400
缺少一个预期的参数
解决方案: 请求中缺少 'module' 参数。请指定模块的 API 名称。请参阅 模块 API 以获取有效的模块 API 名称。 - OAUTH_SCOPE_MISMATCHHTTP 401
未经授权
解决方案:客户端没有ZohoCRM.settings.tags.READ范围。创建一个具有有效范围的新客户端。请参阅范围部分。 - NO_PERMISSIONHTTP 403
无权限读取标签详情
解决方案:用户没有读取标签详情的权限。请联系系统管理员。 - INVALID_URL_PATTERNHTTP 404
请检查尝试访问的URL是否正确
解决方案:请求的URL不正确。请指定一个有效的请求URL。请参阅请求URL部分。 - INTERNAL_ERRORHTTP 500
内部服务器错误
解决方法:服务器中出现意外且未处理的异常。请联系支持团队。
示例响应
Copied{
"tags": [
{
"created_time": "2018-12-28T16:49:07+05:30",
"modified_time": "2019-02-18T23:17:47+05:30",
"name": "Pharma",
"modified_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"id": "3652397000000371014",
"created_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"color_code": “#57B1FD”
},
{
"created_time": "2018-12-28T16:49:07+05:30",
"modified_time": "2019-02-18T23:15:51+05:30",
"name": "Agricultural",
"modified_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"id": "3652397000000371015",
"created_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"color_code": null
},
{
"created_time": "2021-03-01T15:26:47+05:30",
"modified_time": "2021-03-01T15:26:47+05:30",
"name": "Agro",
"modified_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"id": "3652397000003983010",
"created_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"color_code": null
},
{
"created_time": "2021-03-01T15:26:58+05:30",
"modified_time": "2021-03-01T15:26:58+05:30",
"name": "Chem",
"modified_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"id": "3652397000003983017",
"created_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"color_code": null
},
{
"created_time": "2021-10-22T13:08:29+05:30",
"modified_time": "2021-10-22T13:08:29+05:30",
"name": "Nurturing Lead",
"modified_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"id": "3652397000005752002",
"created_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"color_code": null
},
{
"created_time": "2022-03-01T09:25:55+05:30",
"modified_time": "2022-03-01T09:25:55+05:30",
"name": "Nurture1",
"modified_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"id": "3652397000007430004",
"created_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"color_code": "#57B1FD"
}
],
"info": {
"count": 6,
"allowed_count": 200
}
}