Zoho crm Logo

停用数据共享规则

目的

要在您的 Zoho CRM 组织中停用特定的数据共享规则。

请求详情

请求 URL

{api-domain}/crm/{version}/settings/data_sharing/rules/{active_data_sharing_rule_ID}/actions/activate 

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.settings.data_sharing.UPDATE 
(或) 
ZohoCRM.settings.data_sharing.ALL

参数

  • module字符串,必填

    要停用数据共享规则,请指定已配置该规则的模块的 API 名称。  使用 GET - 模块元数据 API 获取模块的 API 名称。

注意

使用 获取数据共享规则 API 列出您组织中的所有数据共享规则 ID。若只想获取活跃规则,请使用 "status" 键,值设为 "active"("status": "active")。

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/data_sharing/rules/2276164000002052006/actions/activate?module=Leads"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

可能的错误

  • REQUIRED_PARAM_MISSINGHTTP 400

    缺少必需参数
    解决方案:请指定 "module" 参数。使用 GET - 模块元数据 API 以检索模块的 API 名称。

  • ID_ALREADY_DEACTIVATEDHTTP 400

    该数据共享规则已被停用
    解决方案:请指定一个已启用的数据共享规则 ID。使用 GET - 数据共享规则 API 获取规则 ID。

  • CANNOT_PROCESS HTTP 400

    无法处理您的请求
    解决方案: 您尝试停用的数据共享规则当前正在由调度程序处理。只有在调度程序完成执行后,API 才能用于其他规则。请稍后重试。

  • INVALID_DATA HTTP 400

    提供的数据共享 ID 似乎无效
    解决方案:请指定一个有效的数据共享规则 ID 以激活。使用 GET - Data Sharing Rules API 来获取数据共享规则 ID。

  • INVALID_REQUEST_METHOD HTTP 400

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

  • OAUTH_SCOPE_MISMATCHHTTP 401

    未授权
    解决方案: 客户端没有用于停用数据共享规则的有效作用域。请创建一个具有有效作用域的新令牌。请参阅作用域部分。

  • AUTHENTICATION_FAILURE HTTP 401

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

  • INVALID_URL_PATTERN HTTP 404

    请检查您要访问的 URL 是否正确
    解决方案: 指定的请求 URL 不正确。请指定有效的请求 URL。有关详细信息,请参阅 请求 URL 部分。 请参阅 请求 URL 部分。

  • INTERNAL_ERROR HTTP 500

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

示例回应

Copied{
    "sharing_rules": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "2276164000002052006"
            },
            "message": "sharing rule is deactivated successfully",
            "status": "success"
        }
    ]
}