创建标签
目的
用于创建标签并对其进行颜色编码。
端点
- POST /settings/tags?module={module_API_name}
请求详情
请求 URL
{api-domain}/crm/{version}/settings/tags
支持的模块
潜在客户,Account,联系人,交易,市场活动,任务,案例,活动,电话,解决方案,产品,Vendors,价目表,报价单,Sales Orders,采购 Orders,Invoices,以及自定义模块。
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.settings.ALL
(或)
ZohoCRM.settings.tags.{operation_type}
可能的操作类型
ALL - 完全数据访问
WRITE - Edit 标签数据
CREATE - 创建标签数据
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/tags?module=Contacts"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@createnewtag.json"Copiedtag1 = Map();
tag1.put("name", "Chems");
tag2 = Map();
tag2.put("name", "Agriculture");
tags_list = List();
tags_list.add(tag1);
tags_list.add(tag2);
param = Map();
param.put("tags", tags_list);
res = invokeurl
[
url :"https://www.zohoapis.com/crm/v8/settings/tags?module=Leads"
type :POST
parameters: param.toString()
connection:"crm_oauth_connection"
];
info res;在输入中,@createnewtag.json 包含示例输入数据。
参数
- module string,必填
指定模块的 API 名称,例如 Leads、Account、Deals 等。
输入 JSON
- name string,必填
指定要创建的标签名称。
- color_code string,可选
指定要添加到标签的颜色的十六进制值。允许的颜色代码为 "#F17574","#F48435","#E7A826","#A8C026","#63C57E","#1DB9B4","#57B1FD","#879BFC","#D297EE","#FD87BD","#969696","#658BA8","#B88562"。如果在输入中不包含此键,颜色代码将被设置为 null。
Edit按版本的标签创建
下表显示各版本的标签创建限制以及每条记录的标签创建限制。
| Edit版本 | 按模块创建标签 | 按记录创建标签 |
|---|---|---|
| 标准版 | 20 | 5 |
| 专业版 | 60 | 10 |
| 企业版 | 100 | 10 |
| 旗舰版 | 200 | 10 |
| Zoho One | 20 | 5 |
| CRM Plus | 200 | 10 |
注意
您最多只能向一个模块添加100个标签,向一条记录添加10个标签。
示例输入
Copied {
"tags": [
{
"name": "Tag3",
"color_code": "#F48435"
},
{
"name": "Tag4",
"color_code": "#F48435"
}
]
}可能的错误
- INVALID_REQUEST_METHODHTTP 400
HTTP 请求方法类型无效
解决方案:您为访问 API URL 指定了无效的 HTTP 方法。请指定有效的请求方法。请参阅端点部分。 - AUTHORIZATION_FAILEDHTTP 400
用户没有足够的权限来创建标签
解决方案:用户没有创建标签的权限。请联系您的系统管理员。 - DUPLICATE_DATAHTTP 400
重复数据
解决方案: 您为一个或多个唯一字段指定了重复的值。请参考 字段元数据 API 以了解哪些字段是唯一的。 - MANDATORY_NOT_FOUNDHTTP 400
- REQUIRED_PARAM_MISSINGHTTP 400
缺少一个预期的 paRAMeter
解决方案:请求中缺少 'module' paRAMeter。请指定模块的 API 名称。使用 模块 API 获取模块的 API 名称。 - INVALID_DATAHTTP 400
- 不支持该颜色。
- 标签名称长度已超过 25 个字符。
- 标签名称包含一个或多个特殊字符:<、> 或逗号。
- 标签名称包含表情符号。
解决方案:
- 您只能将指定的颜色添加到允许的颜色列表中。请参阅请求 JSON部分。
- 标签名称长度不得超过 25 个字符。
- 标签名称不得包含以下特殊字符:<、>,或逗号。
- 标签名称中不能包含表情符号。
- LIMIT_EXCEEDEDHTTP 400
您已添加了 100 个标签并尝试继续添加,或者您正尝试为某条记录添加超过 10 个标签
解决方案:每个模块最多只能添加 100 个标签,每条记录最多只能添加 10 个标签。 - MAPPING_MISMATCHHTTP 400
所提供的标签已存在,且颜色不同。
解决方案:您尝试添加并设置颜色的标签已存在,并且已被映射为不同的颜色。Update同一标签为新的颜色。 - INVALID_MODULEHTTP 400
提供的模块名称似乎无效
解决方案:您指定了无效的模块名称,或者没有选项卡权限,或者该模块可能已从可用模块中移除。请指定有效的模块 API 名称。使用 模块 API 获取模块 API 名称。 - INVALID_MODULEHTTP 400
所提供的模块在 API 中不受支持
解决方案:诸如 Documents 和 Projects 等模块在当前 API 中不受支持。(一旦这些模块得到支持,将不再显示此错误。)请指定有效的模块 API 名称。使用 模块 API 获取模块 API 名称。 - OAUTH_SCOPE_MISMATCHHTTP 401
未经授权
解决方案:客户端没有 ZohoCRM.settings.tags.CREATE 作用域。创建一个具有有效作用域的新客户端。请参阅作用域部分。 - NO_PERMISSIONHTTP 403
无权创建标签
解决方法:用户没有创建标签的权限。请联系系统管理员。 - INVALID_URL_PATTERNHTTP 404
请检查要访问的 URL 是否正确
解决方案: 指定的请求 URL 不正确。请指定有效的请求 URL。请参阅 请求 URL 部分。 - INTERNAL_ERRORHTTP 500
内部服务器错误
解决方案:服务器中出现了意外且未处理的异常。请联系支持团队。
示例响应
Copied{
"tags": [
{
"code": "SUCCESS",
"details": {
"created_time": "2022-03-13T00:58:49+05:30",
"modified_time": "2022-03-13T00:58:49+05:30",
"modified_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"id": "3652397000007549004",
"created_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"color_code": "#F48435"
},
"message": "tags created successfully",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"created_time": "2022-03-13T00:58:49+05:30",
"modified_time": "2022-03-13T00:58:49+05:30",
"modified_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"id": "3652397000007549005",
"created_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"color_code": "#F48435"
},
"message": "tags created successfully",
"status": "success"
}
]
}