Zoho crm Logo

更新共享权限

目的

Update使用此 API 在 Zoho CRM 中记录的共享权限。您可以:

  • Update给予用户的记录共享权限,包括只读、读写或完全访问权限。
  • 撤销用户对共享记录的访问权限。
  • Update已与用户共享的记录的相关列表的访问权限。
  • 以私密或公开方式共享记录。当你公开共享一条记录时,组织中的所有用户都可以访问该共享记录。

端点

  • PUT /{module_API_name}/{record_ID}/actions/share

请求详情

请求 URL

{api-domain}/crm/{version}/{module_api_name}/{record_id}/actions/share

支持的模块

潜在客户、Account、联系人、交易、活动、案例、解决方案、产品、Vendors、价格表、报价、Sales Orders、采购Orders、Invoices,以及自定义。

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.共享.{module_name}.{operation_type}

可能的模块名称

线索、账户、联系人、交易、活动、案例、解决方案、产品、供应商、价格表、报价单、销售订单、采购订单、发票以及自定义。

可能的操作类型

全部 - 完全访问该记录
Update - Update共享权限

注意

  • 系统会自动撤销对未在JSON请求体中提及用户的记录访问权限。因此,请提供所有已共享该记录用户的ID,除非您希望撤销他们的共享权限。

样本请求

Copiedcurl "https://www.zohoapis.com/crm/v8/Contacts/4150868000001148347/actions/share"
-X PUT
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"
Copieduser1 = Map();
user1.put("user", {"id":"4150868000001174048"});
user1.put("share_related_records", true);
user1.put("permission", "full_access");
user1.put("type", "private");
user2 = Map();
user2.put("user", {"id":"4150868000001199001"});
user2.put("share_related_records", true);
user2.put("permission", "read_only");
user2.put("type", "private");

usersList = List();
usersList.add(user1);
usersList.add(user2);

params = Map();
params.put("share", usersList);

response = invokeurl
[
	url :"https://www.zohoapis.com/crm/v8/Leads/692969000000981055/actions/share"
	type :PUT
	parameters: params.toString()
	connection:"crm_oauth_connection"
];
info response;

在请求中,"@input.json" 包含示例输入数据。

请求 JSON

  • shareJSON 数组,必填

    每个 JSON 对象代表要共享该记录的用户、角色或群组集合。

分享属性

  • shared_withJSON 对象,必填 
    • type 字符串,必填
      表示您希望与用户、群组或角色共享该记录。
      可选值:users,groups,roles。
    • id 字符串,必填
      您希望与之共享记录的用户、群组或角色的ID。
  • share_related_records Boolean, 可选

    表示您是否也希望与用户共享相关记录。
    可能的值:
    false - 不共享相关记录。这是默认值。
    true - 与该记录一起共享相关记录。

  • permission字符串,可选

    表示您希望为该记录授予用户的访问权限。
    可能的取值:
    full_access - 允许用户对该记录拥有完全访问权限。这是默认值。
    read_only - 只允许用户查看该记录。
    read_write - 允许用户查看和编辑该记录。

  • type字符串,可选

    表示该记录是公开共享(对组织内所有用户可见)还是私有共享(仅对组织内指定用户可见)。
    可能的取值:
    public - 共享给组织内所有用户。
    private - 共享给指定用户。
    注意,无法将记录以公开方式共享给特定用户。

  • notify Boolean, 可选

    表示您是否希望通知已与其共享记录的用户。
    可能的值:
    true - 通知用户。
    false - 不通知用户。

  • notify_shared_members Boolean, 可选

    指定是否向与该记录共享的所有成员发送通知。
    可能的值:
    false - 不通知用户。此为默认值。
    true - 通知用户。

  • notify_on_completion Boolean, 可选

    指示在记录共享操作完成后,是否应向所有者发送电子邮件通知。
    可能的取值:
    true - 通知所有者。此为默认值。
    false - 不通知所有者。

示例输入

Copied{
    "share": [
        {
            "shared_with": {
                "id": "4876876000001073045",
                "type": "roles"
            },
            "share_related_records": true,
            "permission": "full_access",
            "type": "private"
        }
    ],
    "notify_shared_members": false,
    "notify_on_completion": true
}

可能的错误

  • INVALID_DATAHTTP 400
    • 在URL中提供的记录ID无效,或者不属于指定的模块。
      解决方案:请指定有效的记录ID。
    • 权限无效。
      解决方案:提供的权限值不是以下之一:full_access、read_only 或 read_write。(或)用户没有权限访问该特定模块。请指定有效的权限值。
    • 提供的模块名称似乎无效。
      解决方案:您指定了无效或不受支持的模块名称,或者没有标签权限,或者该模块已从可用模块中移除。请指定有效的模块API名称。详细信息请参考支持的模块列表。
  • INVALID_REQUEST_METHODHTTP 400

    请求方法不正确。
    解决方法:使用 HTTP PUT 方法进行此 API 调用。使用其他请求方法将会导致此错误。

  • AUTHORIZATION_FAILEDHTTP 400

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

  • OAUTH_SCOPE_MISMATCHHTTP 401

    无效的 OAuth 范围,无法访问此 URL
    解决办法: 客户端没有 ZohoCRM.share.{module_name}.UPDATE 的权限范围。
    (或者)
    URL 中指定的模块名称是 Events、Calls、Tasks 或其它关联模块。
    (或者)
    URL 中指定的模块名称无效。请使用此 API 所需的权限范围生成新的访问令牌并重试。

  • SHARE_LIMIT_EXCEEDEDHTTP 403

    无法将记录共享给超过10个用户。
    解决方法:您尝试共享的记录已被共享给10个用户。

  • NO_PERMISSIONHTTP 403

    没有权限更新记录
    解决方法:请联系您的系统管理员。

  • INVALID_URL_PATTERN HTTP 404

    请求的URL不正确。
    解决方法:请指定一个有效的请求URL。有关详细信息,请参阅本页开头的请求URL部分。

  • INTERNAL_ERRORHTTP 500

    服务器出现了意外且未处理的异常。 
    解决方法: 请联系支持团队:support@zohocrm.com。

示例回复

Copied{
    "share": [
        {
            "code": "SUCCESS",
            "details": {},
            "message": "record will be shared successfully",
            "status": "success"
        }
    ]
}