Zoho crm Logo

发送邮件合并

邮件合并

邮件合并功能帮助你创建定制的文档,如表单、信封、信件等。邮件合并Templates允许你使用CRM变量(合并字段),并创建包含这些变量的正确数据的合并文档。你可以使用这些邮件合并Templates向其他用户发送个性化的邮件、信件等,而无需为每个用户手动输入信息。欲了解更多详情,请参阅管理邮件合并Templates。

目的

使用发送邮件合并API来使用邮件合并模板并向用户发送电子邮件。您还可以通过API将文件作为内嵌图片或单独附件附加到电子邮件中。

端点

  • POST /{module_API_name}/{record_id}/actions/send_mail_merge

请求详情

请求 URL

{api-domain}/crm/{version}/{module_API_name}/{record_id}/actions/send_mail_merge

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.settings.mailmerge.CREATE
(和)
ZohoWriter.documentEditor.ALL
(和)
ZohoWriter.merge.ALL
(和)
ZohoCRM.settings.emails.ALL

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/Leads/554023000003128089/actions/send_mail_merge"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"
-X POST
输入 JSON
  • mail_merge_template JSON 对象,必填
    • name 字符串,必填

      您要使用的邮件合并模板的名称。

  • from_address JSON 对象,可选

    您希望用来发送电子邮件的电子邮件地址。此电子邮件地址必须是组织验证的电子邮件地址之一或当前用户的电子邮件ID。

  • to_address JSON 数组,可选

    您希望用来发送电子邮件的邮箱 ID。

  • cc_email JSON 数组,可选

    您希望包含在电子邮件的抄送中的电子邮件详细信息或邮件合并字段。键与 "from_address" JSON 对象中的相同。

  • bcc_email JSON 数组,可选

    您希望包含在邮件密件抄送中的电子邮件或合并字段的详细信息。键与 "from_address" JSON 对象中的键相同。

  • 主题字符串,可选

    电子邮件的主题行。

  • attachment_name 字符串, 可选

    您要在电子邮件中包含的附件名称。

  • 类型字符串,当你想发送附件时是必需的

    你想在邮件中包含的附件类型。可能的值是内嵌,将附件作为内嵌图像发送,和附件,将文件单独发送。

  • 消息字符串,可选

    表示您要发送的电子邮件的正文或内容。最多可包含 100,000 个字符。

注意

  • "from_address"、"to_address"、"cc_email"、"bcc-email" 和 "subject" 的值将从邮件合并模板中获取。如果您想覆盖模板中的值,必须在输入正文中指定这些字段的值。

示例输入

Copied{
    "send_mail_merge": [
        {
            "mail_merge_template": {
                "name": "mailmergename"
            },
            "from_address": {
                "type": "email",
                "value": "p.boyle@gmail.com"
            },
            "to_address": [
                {
                    "type": "email",
                    "value": "smith@gmail.com"
                },
                {
                    "type": "email",
                    "value": "john@gmail.com"
                }
            ],
            "subject": "Hi there",
            "cc_email": [
                {
                    "type": "email",
                    "value": "brie.c@gmail.com"
                }
            ],
            "bcc_email": [
                {
                    "type": "email",
                    "value": "ceo.zylker@gmail.com"
                }
            ],
            "type": "attachment",
            "attachment_name": "testdocument",
            "message": "Big Deal"
        }
    ]
}

可能的错误

  • EXPECTED_FIELD_MISSINGHTTP 400

    您未在"mail_merge_template"键中指定名称。
    解决方案:您必须在"mail_merge_template"键中指定邮件合并模板的名称。

  • INVALID_DATAHTTP 400

    您指定了错误的邮件合并模板名称。
    解决方案:提供正确的邮件合并模板名称。

  • INVALID_EMAILHTTP 400

    您为"from_address"、"to_address"、"cc_email"和"bcc_email"字段中的一个或多个指定了错误的电子邮件地址。
    解决方案:电子邮件ID必须仅属于组织批准的CRM用户或当前用户。

  • DEPENDENT_SERVICE_ERRORHTTP 400
     
  • 您无权使用"from_address"中的电子邮件ID。
    解决方案:联系您的系统管理员。
  • 参数长度超过了允许的限制。请尝试使用较短的参数。
    解决方案:减少消息参数的长度。允许的限制是100,000个字符。
  • INVALID_DATAHTTP 400

    您在 URL 中指定了错误的记录 ID。
    解决方法:在 URL 中提供正确的记录 ID。使用 获取记录 API 来获取记录 ID。

  • INVALID_MODULEHTTP 400

    模块名称无效。
    解决方案:使用 模块 API 获取模块的 API 名称。

  • MANDATORY_NOT_FOUNDHTTP 400

    您未在请求中指定一个或多个必需的键。
    解决方案:请参阅输入 JSON 部分以获取必需键的列表。

  • INVALID_REQUEST_METHODHTTP 400

    HTTP 请求方法无效。
    解决方法:此 API 的 HTTP 请求方法应为 POST。

  • INTERNAL_ERRORHTTP 500

    服务器中未处理的异常。
    解决方案:请联系支持团队,邮箱为support@zohocrm.com。

示例响应

Copied{
    "send_mail_merge": [
        {
            "code": "SUCCESS",
            "details": {
                "report_link": "https://writer.zoho.com/writer/v1/mailmerge/job/4791a19ea20e60e4a17c03f3b5feb149ef2caa18572d9587f26e041e5c47d868dca099732f2d7c6c51fed0693f066194"
            },
            "message": "send mail merge action initiated successfully",
            "status": "success"
        }
    ]
}