Zoho crm Logo

批量删除标签

目的

要从模块中批量Delete标签。这是一个异步API,将安排一个Delete作业。您可以使用 GET - 批量Delete标签Status API获取批量Delete标签作业的Status。

端点

  • POST /settings/tags/actions/mass_delete

请求详情

请求 URL

{api-domain}/crm/{version}/crm/v7/settings/tags/actions/mass_delete

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.settings.ALL   (或)
ZohoCRM.settings.tags.{operation_type}

可能的操作类型

ALL - 完整数据访问 
WRITE - Edit 标签数据 
DELETE - Delete 标签数据

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/tags/actions/mass_delete"
-X POST
-d "input.json"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxd"

输入 JSON

  • mass_deleteJSON 数组,必填

    包含一个模块中标签的详细信息,用于批量标签删除任务。请注意,每次 API 调用只能从一个模块中批量删除标签。

    • moduleJSON 对象,必填 

      表示模块的唯一 ID 及其 API 名称。使用 获取模块元数据 API 来检索模块的 API 名称和 ID。

    • tagsJSON 数组,必填 

      每个 JSON 对象表示一个标签的唯一 ID。使用 获取标签 API 来检索模块中存在的标签及其唯一 ID。每次 API 调用最多可以删除 200 个标签。

示例输入

Copied{
    "mass_delete": [
        {
            "module": {
                "id": "2276164000000000125",
                "api_name": "Leads"
            },
            "tags": [
                {
                    "id": "2276164000001021044"
                },
                {
                    "id": "2276164000001021045"
                },
               .
               .
               .
                {
                    "id": "2276164000001021053"
                }
            ]
        }
    ]
}

响应 JSON 

  • codestring

    表示批量标签删除任务的Status。 

    可能的值: QUEUED, COMPLETED, RUNNING, SCHEDULED, FAILED

  • detailsJSON 对象

    表示批量标签删除任务的唯一标识符。您可以使用批量Delete标签StatusAPI获取计划任务的Status。

  • messageJSON 对象

    表示当前批量标签删除任务的消息。

  • Statusstring

    表示API调用的Status。示例 - "Status": "success"。

可能的错误

  • INVALID_DATAHTTP 400
    • 一个或多个标签似乎无效 
      解决方案:指定有效的标签ID。使用GET Tags API来检索模块中存在的标签及其唯一ID。
    • 标签数量超出限制
      解决方案:在一次API调用中最多可以删除200个标签。请在此限制内指定标签。
    • 给定的数据似乎无效 
      解决方案:指定有效的值。请参阅上面的示例输入部分。
    • "tags"键的数据类型无效
      解决方案:"tags"键应为JSON数组格式。
    • 一个或多个标签似乎缺失
      解决方案:一个或多个指定的标签已被删除。请仅指定尚未删除的标签。
    • "mass_delete" JSON数组超出允许的限制
      解决方案:"mass_delete" JSON数组的最大允许长度为1。
  • NOT_ALLOWEDHTTP 400

    一个或多个标签已被分配给功能 
    解决方案: 要删除标签,它不能与任何功能(如蓝图和工作流规则)相关联。

  • AMBIGUITY_DURING_PROCESSING HTTP 400

    处理过程中存在歧义 
    解决方案:  模块的唯一ID和API名称似乎不匹配。请指定正确的模块ID及其对应的API名称。使用获取模块元数据API  来检索模块的API名称和ID。

  • MANDATORY_NOT_FOUNDHTTP 400

    必填字段似乎缺失 
    解决方案: 指定删除标签所需的所有必填字段。请参阅输入 JSON 部分。

  • INVALID_REQUEST_METHODHTTP 400

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

  • OAUTH_SCOPE_MISMATCHHTTP 401

    未经授权
    解决方法:客户端没有删除标签的有效范围。创建一个具有有效范围的新令牌。请参阅范围部分。

  • Authentication_FAILUREHTTP 401

    Authentication 失败
    解决方法: 在API调用的请求头中传递访问令牌。

  • INVALID_URL_PATTERNHTTP 404

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

  • INTERNAL_ERRORHTTP 500

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

示例响应

Copied{
    "code": "SCHEDULED",
    "details": {
        "job_id": "2276164000001035002"
    },
    "message": "tags scheduled successfully",
    "status": "success"
}