Zoho crm Logo

解除邮箱地址封锁 API

在某些情况下,您发送的邮件会在 Zoho CRM 中被退回,原因可能包括无效的邮箱地址、邮箱已满、域名被屏蔽、邮件服务器宕机、邮件过大等。

有两种类型的退信:

  1. 软退回  - Email暂时无法投递到收件人的Email地址。
    示例:Email服务器故障。
  2. 硬退信(Hard Bounces) - 电子邮件地址永久无法送达。 
    例如:无效的电子邮件地址。

您现在可以使用解除阻止 Email(Soft Bounce)和解除阻止 Email API来解除邮箱的阻止状态。

有关更多详细信息,请参阅避免邮件退回,了解在ZohoCRM中管理邮件退回的更多内容。 
 

目的

解除软退信邮件的阻止。

端点

  • POST /{module_api_name}/{record_id}/actions/unblock_email
  • POST /{module_api_name}/actions/unblock_email

请求详情

请求URLs

要在单个记录中解除电子邮件阻止:

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

要从多个记录中解除电子邮件阻止:

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

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

scope=ZohoCRM.send_mail.{module_API_name}.CREATE

可能的模块Name

线索、客户账户、联系人、商机、报价单、订单、采购订单、发票、案例和自定义

可能的操作类型

创建 - 执行解除邮件阻止的操作

支持的模块

潜在客户、联系人、交易、Account、Sales Orders、采购Orders、Invoices、报价、案件和自定义。 

输入 JSON

  • unblock_fields字符串数组,必填

    要解除Email的阻止,请指定一个或两个系统定义的字段:Email 和 Secondary_Email

  • ids字符串数组,必填如果未在请求的URL中指定 id 时

    如需为多个记录解除Email阻止,请指定记录 ID。最多可指定 500 个记录 ID。

注意事项

  • 永久阻止的邮箱无法解除阻止。
  • 临时阻止的邮箱最多可以解除阻止5次。
  • 自定义邮箱字段无法解除阻止。
  • 无法合并已锁定或处于审批流程/审核流程中的记录。

与单个记录相关联的邮件解封申请示例

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

示例输入

Copied{
    "unblock_fields": [
        "Email",
        "Secondary_Email"
    ]
}

可能的错误

  • NOT_ALLOWEDHTTP 400

    提供了未知字段
    解决方法:您指定了未知字段。请指定支持的字段,例如 Emails 和/或 Secondary_Email。

  • INVALID_DATAHTTP 400

    提供了无效的记录
    解决方法:您已指定了一个或多个无效的记录ID。请提供有效的记录ID。

  • NOT_ALLOWEDHTTP 400

    EMAIL,SECONDARY_EMAIL 字段在该模块中不可用
    解决方法: 所提供的字段在指定模块中不可用。请指定有效的字段。

  • NOT_ALLOWEDHTTP 400

    无法取消封锁,该邮箱已被取消封锁5次
    解决方法:同一个邮箱最多只能取消封锁5次。

  • NOT_ALLOWEDHTTP 400

    无法解除封锁,Email已被永久封锁
    解决方法:您可以解除临时封锁的Email,但无法解除已被永久封锁的Email。

  • NOT_ALLOWEDHTTP 400

    Email 已经被解封
    解决方法:所提供的 Email 已经被解封。

  • MANDATORY_NOT_FOUNDHTTP 400

    未找到必填字段
    解决方法: 输入内容不能为空。请提供所需的字段以解除邮箱阻塞。

  • INVALID_REQUEST_METHODHTTP 400

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

  • INVALID_MODULEHTTP 400

    给定的模块名称似乎无效
    解决方法:您指定了一个无效的模块名称。
    请指定一个有效的模块名称。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    未授权
    解决方法:客户端没有 ZohoCRM.modules.{module_name}.UPDATE 权限范围。
    请创建一个具有有效权限范围的新令牌。请参阅上方的权限范围部分。

  • Authentication_失败HTTP 401

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

  • INVALID_URL_PATTERNHTTP 404

    请检查尝试访问的URL是否正确
    解决方案: 请求的URL不正确。请指定一个有效的请求URL。请参考上方的请求URL部分。

  • INTERNAL_ERRORHTTP 500

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

示例回复

Copied{
    "data": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "2423488000000569001"
            },
            "message": "Unblocked successfully",
            "status": "success"
        }
    ]
}

批量邮件解封申请示例

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

示例输入

Copied{
    "unblock_fields": [
        "Email",
        "Secondary_Email"
    ],
    "ids": [
        "2423488000000575001",
        "2423488000000569124",
        "2423488000000569119"

    ]
}

示例回复

Copied{
    "data": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "2423488000000575001"
            },
            "message": "Unblocked successfully",
            "status": "success"
        },
        {
            "code": "SUCCESS",
            "details": {
                "id": "2423488000000569124"
            },
            "message": "Unblocked successfully",
            "status": "success"
        },
        {
            "code": "SUCCESS",
            "details": {
                "id": "2423488000000569119"
            },
            "message": "Unblocked successfully",
            "status": "success"
        }
    ]
}