Zoho crm Logo

删除记录的领土

目的

要在您的Zoho CRM组织中删除分配给多个记录或单个记录的区域。

端点

  • POST /{module_api_name}/actions/remove_territories
  • POST /{module_api_name}/{record_ID}/actions/remove_territories

请求详情

请求 URL

{api-domain}/crm/{version}/{module_api_name}/actions/remove_territories

移除单个记录的领土:
{api-domain}/crm/{version}/{module_api_name}/{record_ID}/actions/remove_territories

支持的模块

潜在客户,Account,联系人和交易

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

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

可能的模块名称

线索、账户、联系人和交易

可能的操作类型

全部 - 完全访问记录
更新 - 更新模块中的记录

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/Accounts/actions/remove_territories"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d @removeterritories.json
-X POST

请求 JSON 键

  • id字符串,如果未在 URL 中指定则为必填项

    表示您要移除其领土的交易、Account或联系人的唯一 ID。

  • TerritoriesJSON 数组,必填项

    数组中的每个 JSON 对象表示您要为记录移除的领土的唯一 ID。使用 获取领土 API 获取可用领土及其各自唯一 ID 的列表。

示例输入

Copied{
    "data": [
        {
            "id": "554023000003635023", //record_id
            "Territories": [
                {
                    "id": "554023000000430409"
                },
                {
                    "id": "554023000000430451"
                }
            ]
        }
    ]
}

响应 JSON 键

  • code string

    表示响应代码。"SCHEDULED" 表示作业已成功安排以移除区域。

  • details JSON object
    • id-string - 表示要移除其区域的记录的 ID。
    • job_id-string - 表示安排移除记录区域的作业的 ID。使用记录 ID 在 获取 特定功能信息 API 中获取该记录的安排作业的详细信息。

可能的错误

  • ALREADY_SCHEDULEDHTTP 400

    您正在尝试再次从记录中移除区域,但一个任务已经被安排。
    解决方案:在安排任务后,使用获取特定功能信息API来获取该记录的已安排任务的状态。

  • INVALID_DATAHTTP 400

    提供的记录ID似乎无效
    解决方案:请求中指定的记录ID不正确。使用获取记录API来获取可用记录及其各自的唯一ID。在请求中指定有效的记录ID。

  • INVALID_DATAHTTP 400

    给定的ID似乎无效
    解决方案:您指定了一个错误的领地ID(或)您正在尝试移除未分配给该记录的领地。"details"键提供了包含无效ID的领地JSON对象的路径。使用获取领地API来获取可用领地及其各自唯一ID的列表。在请求输入中指定有效的领地ID。

  • MANDATORY_NOT_FOUNDHTTP 400

    缺少一个预期的参数
    解决方案:您未指定要从中删除区域的记录的唯一ID。使用获取记录API来获取可用记录及其各自唯一ID的列表。在请求输入中指定有效的记录ID。

  • MANDATORY_NOT_FOUNDHTTP 400

    必填字段未找到
    解决方案:您未在输入中指定区域 ID(或)为 "Territories" 键传递了一个空的 JSON 数组(或)您未在请求输入中指定 "Territories" 键。使用 获取区域 API 获取可用区域及其各自的唯一 ID 列表。在请求输入中指定有效的区域 ID。

  • TERRITORY_NOT_ENABLEDHTTP 403

    您正在尝试从潜在客户模块中的记录中删除一个区域
    解决方案:您不能使用此 API 直接从潜在客户中删除区域。请联系支持团队提出请求。

  • NOT_ALLOWEDHTTP 403

    您正在尝试从记录中移除系统分配的区域。解决方案:您不能从记录中移除系统分配的区域。

  • INVALID_DATAHTTP 207

    请求输入中的一个或多个键具有无效值。响应包含多个响应状态。
    解决方法:请参阅上面的请求JSON键部分,并指定有效的请求输入。

  • RECORD_LOCKEDHTTP 400

    您无法执行此操作,因为记录已被锁定。
    解决方案:请等待记录解锁。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    访问此URL的 OAuth 范围无效
    解决方案:客户端没有ZohoCRM.modules.{module_name}.UPDATE 范围。创建一个具有有效范围的新客户端。请参阅上面的范围部分。

  • NO_PERMISSIONHTTP 403

    无权限更新记录
    解决方案:用户没有更新记录的权限。请联系系统管理员。

  • INTERNAL_ERRORHTTP 500

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

  • INVALID_REQUEST_METHODHTTP 400

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

  • AUTHORIZATION_FAILEDHTTP 401

    用户没有足够的权限更新记录
    解决方案:用户没有更新记录的权限。请联系您的系统管理员。

示例响应

Copied{
    "data": [
        {
            "code": "SCHEDULED",
            "details": {
                "job_id": "554023000003908009",
                "id": "554023000003635023"
            },
            "message": "Territory removal process scheduled successfully",
            "status": "success"
        }
    ]
}