共享记录
目的
在Zoho CRM中与其他用户、团队和角色共享记录。
端点
- POST /{module_API_name}/{record_ID}/actions/share
请求详情
请求 URL
{api-domain}/crm/{version}/{module_API_name}/{record_ID}/actions/share
支持的模块
潜在客户、账户、联系人、交易、活动、案件、解决方案、产品、供应商、价格书、报价单、销售订单、采购订单、发票和自定义模块。
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.share.{module_name}.{operation_type}
(或)
ZohoCRM.share.all
可能的模块名称
潜在客户、客户、联系人、交易、活动、案例、解决方案、产品、供应商、价目表、报价单、销售订单、采购订单、发票和自定义。
可能的操作类型
ALL - 完全访问记录
CREATE - 与组织中的其他用户共享记录
注意
- 只有在满足特定条件的情况下,记录才能与组织中的其他用户共享。为了简单起见,假设用户A与用户B共享一条记录。现在,用户A只能在以下情况下成功共享记录:
- 用户B是一个确认的并且活跃的用户。
- 用户B尚未获得该特定记录的访问权限。
- 用户B具有该特定模块的访问权限。例如,要分享一个联系人,用户B必须具有联系人模块的访问权限。
- 您不能直接共享“电话”、“会议”、“任务”和“链接”模块中的记录。它们可以作为相关列表进行共享。
- 具有共享权限的用户可以共享他们有访问权限的任何记录,除了共享给他们的记录。要检查这一点,请前往设置> 用户和控制> 安全控制> 选择配置文件> 工具权限。检查是否启用了“共享”。对于标准和管理员配置文件,默认启用。
- 形成多对多关系(带有多选查找)的记录详细信息不能被共享。
- 一条记录只能与10个用户、5个群组和5个角色共享。
- 一旦记录成功共享,发起共享操作的用户可以通过电子邮件收到通知。
- 用户可以使用PUT方法更新共享记录。要了解更多信息,请参阅更新记录。
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Leads/3652397000001970045/actions/share"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"在请求中,"@input.json" 包含示例输入数据。
输入 JSON
- 共享 JSON 数组,必填
每个 JSON 对象代表您希望与其共享记录的用户、角色或组的集合。
分享属性
- shared_with JSON 对象,必填
- type 字符串,必填
表示您希望将记录共享给用户、组或角色。
可能的值 :users,groups,roles。 - id 字符串,必填
要将记录共享给的用户、组或角色的ID。
- type 字符串,必填
- share_related_records 布尔值,可选
表示是否希望也将相关记录与用户共享。
可能的值:
false - 不共享相关记录。这是默认值。
true - 将相关记录与主记录一起共享。 - 权限字符串,必需
表示您希望为用户授予共享记录的访问权限。
可能的值:
full_access - 允许用户完全访问记录。这是默认值。
read_only - 允许用户仅查看记录。
read_write - 允许用户查看和编辑记录。 - 字符串类型,必填
表示记录是公开共享(对组织内所有用户)还是私密共享(对组织内的特定用户)。
可能的值:
public - 共享给组织内所有用户。
private - 共享给特定用户。
请注意,当私密共享记录时("type" : "private"),share_with JSON 对象键是必填的。 - notify_shared_members Boolean,可选
指定是否向所有共享记录的成员发送通知。
可能的值:
false - 不通知用户。这是默认值。
true - 通知用户。 - notify_on_completion 布尔值,可选
指示在记录共享操作完成后是否应向所有者发送电子邮件通知。
可能的值:
true - 通知所有者。这是默认值。
false - 不通知所有者。
示例输入
Copied{
"share": [
{
"shared_with": {
"id": "5725767000002350003",
"type": "roles"
},
"share_related_records": false,
"permission": "full_access",
"type": "private"
},
{
"shared_with": {
"id": "5725767000002868044",
"type": "groups"
},
"share_related_records": false,
"permission": "full_access",
"type": "private"
},
{
"shared_with": {
"id": "5725767000002868058",
"type": "roles"
},
"share_related_records": false,
"permission": "full_access",
"type": "private"
},
{
"shared_with": {
"id": "5725767000002868072",
"type": "users"
},
"share_related_records": false,
"permission": "full_access",
"type": "private"
},
{
"shared_with": {
"id": "5725767000002868086",
"type": "groups"
},
"share_related_records": false,
"permission": "full_access",
"type": "private"
}
],
"notify_shared_members": false,
"notify_on_completion": true
}可能的错误
- INVALID_DATA HTTP 400
- INVALID_REQUEST_METHOD HTTP 400
请求方法不正确。
解决办法:使用 HTTP POST 方法来进行此 API 调用。任何其他请求方法都会导致此错误。 - AUTHORIZATION_FAILED HTTP 400
用户没有足够的权限共享记录。
解决方法: 联系您的系统管理员。 - INVALID_MODULE HTTP 400
所给模块名称似乎无效或您指定了不支持的模块。
解决方法: 指定有效的模块 API 名称。有关详细信息,请参阅支持的模块列表。 - AMBIGUITY_DURING_PROCESSING HTTP 400
对于公共共享,提供了多个json对象。
解决方案:当您共享一个记录并将其设为公开时,输入中必须仅包含一个带有键“type”、“permission”和“share_related_records”的JSON对象。您不能将记录公开并同时与特定用户共享。 - CANNOT_PROCESS HTTP 400
调度程序正在运行。
解决方法:请求中的记录已被安排共享。请稍后再试。 - MANDATORY_NOT_FOUNDHTTP 400
缺少必填字段。
解决方案:一个或多个必填字段缺失。请在输入中指定所有必填字段。更多详情请参阅输入JSON部分。 - OAUTH_SCOPE_MISMATCH HTTP 401
您用于进行此次 API 调用的访问令牌没有所需的范围。
解决方案:生成一个具有该 API 所需范围的新访问令牌。请参阅本页开头的范围部分以获取所需范围的列表。 - LIMIT_EXCEEDED HTTP 403
已达到记录共享限制。
解决方案: 请在指定限制内共享记录。您最多可以将记录共享给 10 个用户,5 个组,和 5 个角色。 - NOT_ALLOWED HTTP 403
此组织未启用信息流。
解决方案:如果您从“组织模块”中删除了“信息流”,则无法通知用户。将“信息流”添加到“组织模块”中,以便在共享记录时通知用户。 - NO_PERMISSION HTTP 403
无权限共享记录。
解决方法:请联系系统管理员。 - INVALID_URL_PATTERN HTTP 404
请求的 URL 不正确。
解决方法:指定有效的请求 URL。有关详细信息,请参阅本页面开头的请求 URL部分。 - INTERNAL_ERROR HTTP 500
服务器中发生了意外且未处理的异常。
解决方案: 联系支持团队:support@zohocrm.com。
示例响应
Copied{
"share": [
{
"code": "SUCCESS",
"details": {},
"message": "record will be shared successfully",
"status": "success"
},
{
"code": "SUCCESS",
"details": {},
"message": "record will be shared successfully",
"status": "success"
},
{
"code": "SUCCESS",
"details": {},
"message": "record will be shared successfully",
"status": "success"
},
{
"code": "SUCCESS",
"details": {},
"message": "record will be shared successfully",
"status": "success"
},
{
"code": "SUCCESS",
"details": {},
"message": "record will be shared successfully",
"status": "success"
}
]
}