Zoho crm Logo

从记录中移除标签

目的

删除与记录相关的标签。

端点

  • POST /{module_API_name}/actions/remove_tags
  • POST /{module_API_name}/{record_ID}/actions/remove_tags

请求详情

请求 URL

从多个记录中删除多个标签:
{api-domain}/crm/{version}/{module_API_name}/actions/remove_tags 

要从特定记录中移除标签:
{api-domain}/crm/{version}/{module_API_name}/{record_ID}/actions/remove_tags

支持的模块

潜在客户,Account,联系人,交易,活动,任务,案例,事件,电话,解决方案,产品,Vendors,价格表,报价单,Sales Orders,采购Orders,Invoices,以及自定义模块。

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.modules.ALL
(或)
ZohoCRM.modules.{module_name}.{operation_type}

可能的模块名称

线索、账户、联系人、交易、活动、任务、案例、事件、电话、解决方案、产品、供应商、价格表、报价单、销售订单、采购订单、发票和自定义模块。

可能的操作类型

全部 - 完全访问记录
写入 - Edit模块中的记录

示例请求:从多个记录中删除多个标签

Copiedcurl "https://www.zohoapis.com/crm/v8/Leads/actions/remove_tags"
-X POST
-d @input.json
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedtag1 = Map();
tag1.put("name","Prime");
tag2 = Map();
tag2.put("name","Attend First");
tags_list = List();
tags_list.add(tag1);
tags_list.add(tag2);
param = Map();
param.put("tags",tags_list);
recordIDs = List();
recordIDs.add('554023000002365002');
recordIDs.add('554023000001736019');
param.put("ids",recordIDs);

res = invokeurl
[
	url :"https://www.zohoapis.com/crm/v8/Leads/actions/remove_tags"
	type :POST
	parameters: param.toString()
	connection:"zohooauth"
];

输入 JSON

  • tagsJSON 对象,必填

    指定要从记录中删除的标签名称。

  • idsJSON 数组,当从多个记录中删除标签时必填

    指定要删除标签的记录ID,多个ID用逗号分隔。最多可以指定 500 个记录ID。使用 GET - Records API检索记录ID。

从多个记录中删除多个标签的示例输入

Copied{
    "tags": [
        {
            "name": "Prime"
        },
        {
            "name": "Attend First"
        }
    ],
    "ids": [
        "554023000000793002",
        "554023000000792001"
    ]
}

可能的错误

  • INVALID_URL_PATTERNHTTP 404

    请检查尝试访问的URL是否正确
    解决方案:请求的URL不正确。请指定一个有效的请求URL。请参阅请求URL部分。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    未经授权
    解决方案:客户端没有ZohoCRM.modules.{module_name}.WRITE范围。创建一个具有有效范围的新客户端。请参阅范围部分。

  • NO_PERMISSIONHTTP 403

    没有权限删除标签
    解决方案:用户没有权限从记录中删除标签。请联系系统管理员。

  • INTERNAL_ERRORHTTP 500

    内部服务器错误
    解决方法:服务器中出现意外且未处理的异常。请联系支持团队。

  • INVALID_REQUEST_METHODHTTP 400

    HTTP请求方法类型无效
    解决方案:您指定了一个无效的HTTP方法来访问API URL。请指定一个有效的请求方法。请参阅端点部分。

  • AUTHORIZATION_FAILEDHTTP 400

    用户没有足够的权限来移除标签
    解决方案: 用户没有权限从记录中移除标签。请联系系统管理员。

  • INVALID_MODULEHTTP 400

    给定的模块名称似乎无效
    解决方法:您指定了一个无效的模块名称,或者没有标签权限,或者该模块可能已从可用模块中删除。请指定一个有效的模块 API 名称。请参阅 GET - Modules Metadata API 以检索模块 API 名称。

  • INVALID_MODULEHTTP 400

    给定的模块在 API 中不受支持
    解决方案: 当前 API 不支持 Documents 和 Projects 等模块。(一旦这些模块被支持,此错误将不会显示)。请指定一个有效的模块 API 名称。

示例响应

Copied{
    "data": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "554023000000793002",
                "tags": [
                    {
                        "name": "Nurture",
                        "id": "554023000002555018",
                        "color_code": "#57B1FD"
                    }
                ]
            },
            "message": "tags updated successfully",
            "status": "success"
        },
        {
            "code": "SUCCESS",
            "details": {
                "id": "554023000000792001",
                "tags": [
                    {
                        "name": "Nurturing Lead",
                        "id": "554023000002172011",
                        "color_code": "#57B1FD"
                    },
                    {
                        "name": "web",
                        "id": "554023000001180007",
                        "color_code": null
                    }
                ]
            },
            "message": "tags updated successfully",
            "status": "success"
        }
    ],
    "locked_count": "0"
}

单个记录删除标签的示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/Leads/554023000000792001/actions/remove_tags"
-X POST
-d @input.json
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

从单个记录中删除标签的示例输入

Copied{
    "tags": [
        {
            "name": "Prime"
        },
        {
            "name": "Attend First"
        }
    ]
}

示例响应

Copied{
    "data": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "554023000000792001",
                "tags": [
                    {
                        "name": "web",
                        "id": "554023000001180007"
                    }
                ]
            },
            "message": "tags updated successfully",
            "status": "success"
        }
    ]
}