更新标签
目的
更新标签及其颜色代码。
端点
- PUT /settings/tags?module={module_api_name}
- PUT /settings/tags/{tag_id}?module={module_api_name}
请求详情
请求 URL
要更新多个标签:
{api-domain}/crm/{version}/settings/tags
要更新特定标签:
{api-domain}/crm/{version}/settings/tags/{tag_ID}
支持的模块
线索,Account,联系人,交易,营销活动,任务,案例,事件,通话,解决方案,产品,Vendors,价格表,报价,SalesOrders,采购Orders,Invoices,以及自定义模块。
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.settings.ALL
(或)
ZohoCRM.settings.tags.{operation_type}
可能的操作类型
ALL - 完全数据访问权限
WRITE - Edit标签数据
Update - Update标签数据
参数
- module字符串,必填
指定模块的 API 名称,例如线索、联系人、Account、商机等。
示例请求以更新多个标签
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/tags?module=Contacts"
-X PUT
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@multipletagupdate.json"Copiedtag1 = Map();
tag1.put("name", "chem");
tag1.put("id", "692969000000995008");
tag2 = Map();
tag2.put("name", "Agriculture");
tag2.put("id", "692969000000995002");
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 :PUT
parameters: param.toString()
connection:"crm_oauth_connection"
];
info res;在输入中,@multipletagupdate.json 包含示例输入数据。
输入 JSON
- id字符串,批量更新标签时必填
指定你要更新的标签的唯一ID。可使用 GET - 标签API 获取标签ID。
- color_code字符串,选填
指定你想要添加到标签的颜色的十六进制值。允许的颜色代码包括 "#F17574","#F48435","#E7A826","#A8C026","#63C57E","#1DB9B4","#57B1FD","#879BFC","#D297EE","#FD87BD","#969696","#658BA8","#B88562"。如果输入中不包含该键,颜色代码将被设置为null。
示例输入
Copied{
"tags": [
{
"id": "3652397000007505226",
"name": "Nurture2",
"colour_code": "#57B1FD"
},
{
"id": "3652397000007587145",
"name": "Wanted",
"colour_code": "#B88562"
},
{
"id": "3652397000007511001",
"name": "Rejected",
"colour_code": "#969696"
}
]
}可能的错误
- INVALID_MODULEHTTP 400
提供的模块名称似乎无效
解决方法:您指定了无效的模块名称,或者没有该标签页的权限,或者该模块可能已从可用模块中移除。请指定有效的模块 API 名称。使用 模块 API 获取模块 API 名称。 - INVALID_MODULEHTTP 400
所提供的模块在 API 中不被支持
解决方法:诸如“文档”和“项目”等模块当前在 API 中不被支持。(一旦这些模块被支持,此错误不会再显示。)请指定有效的模块 API 名称。请使用模块 API获取模块的 API 名称。 - INVALID_REQUEST_METHODHTTP 400
HTTP请求方法类型无效
解决方法:您为访问API URL 指定了无效的HTTP方法。请指定有效的请求方法。请参阅 端点 部分。 - AUTHORIZATION_FAILEDHTTP 400
用户没有足够的权限来更新标签
解决方案:该用户没有更新标签的权限。请联系您的系统管理员。 - INVALID_DATAHTTP 400
- 该颜色不被支持。
- 标签名称长度已超过25个字符。
- 标签名称包含一个或多个特殊字符:<、> 或逗号。
- 标签名称中包含表情符号(emoji)。
- 标签的ID无效。
解决方法:
- 你只能添加允许颜色列表中指定的其中一种颜色。
- 标签名称长度不能超过25个字符。
- 标签名称不能包含以下特殊字符:<、> 或 逗号。
- 标签名称中不能含有表情符号(emoji)。
- 请指定有效的标签ID以进行更新。
- DUPLICATE_DATAHTTP 400
数据重复
解决方法:您为一个或多个唯一字段指定了重复的值。请参考 字段元数据 API 以了解唯一字段。 - MANDATORY_NOT_FOUNDHTTP 400
未找到必填字段
解决方法:您在输入中未指定一个或多个必填字段。请参考字段元数据 API以了解必填字段。 - REQUIRED_PARAM_MISSINGHTTP 400
缺少一个预期的参数
解决方法:请求中缺少 'module' 参数。请指定模块的 API 名称。使用 模块 API 获取模块的 API 名称。 - OAUTH_SCOPE_MISMATCHHTTP 401
未授权
解决方法:客户端没有 ZohoCRM.settings.tags.UPDATE 权限范围。请创建一个具有有效权限范围的新客户端。请参阅 权限范围 部分。 - NO_PERMISSIONHTTP 403
无权限更新标签详情
解决方法:用户没有更新标签的权限。请联系系统管理员。 - INVALID_URL_PATTERNHTTP 404
请检查您尝试访问的URL是否正确
解决办法:请求的URL不正确。请指定一个有效的请求URL。请参阅请求URL部分。 - INTERNAL_ERRORHTTP 500
服务器内部错误
解决方法:服务器出现意外且未处理的异常。请联系支持团队。
示例响应
Copied{
"tags": [
{
"code": "SUCCESS",
"details": {
"created_time": "2022-03-13T16:29:23+05:30",
"modified_time": "2022-03-13T01:15:43+05:30",
"modified_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"id": "3652397000007505226",
"created_by": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"color_code": null
},
"message": "tags updated successfully",
"status": "success"
}
]
}