向特定记录添加标签
目的
向特定记录添加标签。
请求URL
https://www.zohoapis.com.cn/crm/v2/{module_api_name}/{record_id}/actions/add_tags?tag_names={tag1},{tag2}
范围
module_api_name - 模块的API名称
record_id - 标签的唯一ID
请求方法
POST
范围
scope=ZohoCRM.modules.all
(或)
scope=ZohoCRM.modules.{module_name}.{operation_type}
| 可能的模块名称 | 可能的操作类型 |
|---|---|
| leads, accounts, contacts, deals, campaigns, tasks, cases, events, calls, solutions, products, vendors, pricebooks, quotes, salesorders, purchaseorders, invoices, and custom | ALL - 完全数据访问 WRITE - 编辑标签数据 CREATE - 创建标签数据 |
参数
| 参数名称 | 数据类型 | 描述 |
|---|---|---|
| tag_names (必填) | 字符串 | 指定要添加的标签名称。 |
| over_write | Boolean | 指定是否要覆盖现有标签。默认值是false。 |
示例请求
curl "https://www.zohoapis.com.cn/crm/v2/Contacts/2445013000000402006/actions/add_tags?tag_names=From Email,High Priority&over_write=true"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf" 示例响应
{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "2445013000000402006",
"tags": [
"From Webforms",
"High Priority"
]
},
"message": "tags updated successfully",
"status": "success"
}
]
} 示例请求
/** Add Tags to a Specific record */
$zcrmRecordIns = ZCRMRecord::getInstance("Leads","3372164000001254034"); //模块API名称 , 3372164000001254034 标签ID
$tagNames = array("Name5","Name6");
$apiResponse = $zcrmRecordIns->addTags($tagNames); //$tagNames是数组
$record = $apiResponse->getData(); //$record - ZCRMRecord实例 示例响应
{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "2445013000000402006",
"tags": [
"From Webforms",
"High Priority"
]
},
"message": "tags updated successfully",
"status": "success"
}
]
} 示例请求
ZCRMRecord recordIns = ZCRMRecord.GetInstance("Leads", 3372164000001600009);//模块API名称 , 3372164000001254034 record id
List<string> tagNames = new List<string>{ "Name5", "Name6" };
APIResponse response = recordIns.AddTags(tagNames); //tagNames是数组
ZCRMRecord record = (ZCRMRecord)response.Data; 示例响应
{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "2445013000000402006",
"tags": [
"From Webforms",
"High Priority"
]
},
"message": "tags updated successfully",
"status": "success"
}
]
}