Zoho crm Logo

记录级别的邮件取消共享

目的

通过 API,在您的Zoho CRM 组织中,针对特定记录或多个记录,与其他用户取消在记录级别共享邮件。

端点

  • POST /{module_API_name}/actions/unshare_emails
  • POST /{module_API_name}/{record_ID}/actions/unshare_emails

请求详情

请求 URL

要在记录级别取消共享多条记录的电子邮件:
{api-domain}/crm/{version}/{module_API_name}/actions/unshare_emails

要在记录级别取消共享某一条记录的电子邮件:
{api-domain}/crm/{version}/{module_API_name}/{record_ID}/actions/unshare_emails

支持的模块

潜在客户、联系人和自定义模块

标题

授权:Zoho-oauthtokend92d4xxxxxxxxxxxxx15f52

范围

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

可能的模块名称

线索、联系人和自定义模块

可能的操作类型

ALL - 完全访问该记录
CREATE - 创建该记录的权限

示例请求

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

输入 JSON

  • idsJSON 数组,取消共享多个记录ID的邮件时必填。

    一个以逗号分隔的记录ID数组。这些是所需模块中你要取消邮件共享的记录的唯一ID。每次API调用最多可取消共享200条记录。

注意

在取消共享单条记录的邮件时,请跳过输入JSON。如果提供了输入JSON,系统将会忽略。

示例输入

Copied{
    "ids": [
        "5843104000000425566",
        "5843104000000425570"
    ]
}

可能的错误

  • NOT_SHARED HTTP 400

    Emails已不再与同事共享
    解决方法:无需操作;Emails已经取消共享。

  • INVALID_DATAHTTP 400

    所提供的记录ID似乎无效。
    解决方法:请确保输入JSON中的记录ID是正确的。

  • INVALID_DATAHTTP 400

    所提供的相关ID似乎无效
    解决方法: 确保端点中的记录ID是正确的。

  • NOT_ALLOWEDHTTP 400

    Email 配置不存在
    解决方法:为您的 Email 集成进行配置,以用于您在 Zoho CRM 组织中的账户。

  • NOT_ALLOWEDHTTP 400

    用户未启用自定义共享
    解决方法:为您的 Zoho CRM 组织设置自定义邮件共享权限。

  • NOT_SUPPORTEDHTTP 400

    所提供的模块在 API 中不受支持
    解决方案: 支持的模块包括潜在客户、联系人和自定义模块。

  • INVALID_REQUEST_METHODHTTP 400

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

  • OAUTH_SCOPE_MISMATCHHTTP 401

    您用于进行此 API 调用的访问令牌不具有所需的权限范围
    解决方法: 生成一个包含此 API 所需权限范围的新访问令牌。请参阅本页开头的权限范围部分,获取所需权限范围的列表。

  • INVALID_URL_PATTERN HTTP 404

    请求的URL不正确
    解决方法:请指定一个有效的请求URL。更多详情请参阅本页开头的请求URL部分。

  • INTERNAL_ERRORHTTP 500

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

示例回复

Copied{
    "data": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "5843104000000425566"
            },
            "message": "Sharing revoked successfully",
            "status": "success"
        },
        {
            "code": "SUCCESS",
            "details": {
                "id": "5843104000000425570"
            },
            "message": "Sharing revoked successfully",
            "status": "success"
        }
    ]
}