Zoho crm Logo

创建电子邮件草稿

目的

要创建 Email 草稿。在 Zoho CRM 中。草稿将保存在相应记录的 Email 相关列表中,每次 API 调用最多 100 个 Email 草稿。

端点

  • POST /{module_API_name}/{record_ID}/__email_drafts

请求详情

请求 URL

{api-domain}/crm/{version}/{module_API_name}/{record_ID}/__email_drafts

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

支持的模块

潜在客户、联系人、商机、Account、Sales Orders、采购 Orders、Invoices、报价单、案例,以及自定义模块。

范围

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

可能的模块 Name

线索、客户、联系人、交易、报价、销售订单、采购订单、发票、案例以及自定义

可能的操作类型

ALL - 对模块的完全访问权限
CREATE - 对该模块的创建权限

示例请求

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

输入 JSON

  • reply_to电子邮件地址,可选

    您希望用户在收到邮件后回复到的电子邮件地址。

  • 发件人电子邮件地址,必填

    发送电子邮件所用的电子邮件地址。

  • 收件人JSON array,可选

    用于指定电子邮件收件人(可为多个)的 JSON 对象数组。每个对象应包含收件人的姓名和电子邮件地添加址。添加 多个 JSON 对象以为多个收件人创建电子邮件草稿。

  • ccJSON array,可选

    用于抄送收件人的 JSON 对象数组。每个对象包含收件人的姓名和电子邮件地添加址。添加 多个 JSON 对象以包含多个抄送收件人。

  • bccJSON array,可选

    用于 BCC 收件人的 JSON 对象数组。每个对象包括收件人的姓名和电子邮件添加ress. 添加 多个 JSON 对象以支持多个 BCC 收件人。

  • rich_text Boolean,必填

    指定电子邮件格式。可选项为: 
    true :富文本
    false :纯文本

  • subject String,可选

    电子邮件的主题。

  • 内容字符串,可选

    电子邮件的内容或正文,可以是纯文本或富文本格式。

  • schedule_detailsJSON object,可选

    用于安排Email的详细信息。请注意,创建的草稿将在Email相关列表的草稿部分中可用,而不是已计划部分。

    • timeDateTime,如果指定了schedule_details键,则为必填

      草稿的计划时间。请注意,该时间应为将来时间。

  • inventory_detailsJSON object,可选

    与电子邮件的库存模板相关的详细信息。此键仅适用于库存模块。

    • inventory_template字符串,若指定了 inventory_details 键则为必填

      要在电子邮件中使用的库存模板的唯一 ID。

    • paper_type字符串,可选

      数字打印的纸张类型。 
      可能的取值:A4, default, us_letter。默认值为 A4。

    • view_type字符串,可选

      您希望查看模板的方式。 
      可能的取值:portrait,landscape。默认值为 portrait。

  • attachmentsJSON array,可选

    附件详情的数组。您可以使用 Files API 上传文件。

    • id字符串,如果指定了 attachments 键则为必填

      附件的唯一 ID。

    • file_name字符串,必填

      附件的文件名。请注意,此名称将覆盖附件的实际名称。

示例输入

Copied{
   "__email_drafts":[
      {
         "reply_to":"pat.boyle@zylker.com",
         "from":"patricia.boyle@zylker.com",
         "to":[
            {
               "user_name":"user1",
               "email":"user1@zylker.com"
            }
         ],
         "cc":[
            {
               "user_name":"user2",
               "email":"user2@zylker.com"
            }
         ],
         "bcc":[
            {
               "user_name":"user4",
               "email":"user4email@zoho.com"
            }
         ],
         "subject":"Test Draft",
         "content":"This is the email content.",
         "rich_text":true,
         "schedule_details":{
            "time":"2023-11-30T18:40:00+05:30"
         },
         
         "attachments":[
            {
               "id":"0b9e5596cdd8cafe6a5c09f78f095bd6434c863110a6d1e094285c6ebf9dd0d5db4eff3bbccadddbf58afe55b1dd7c71",
               "file_name":"attachment.txt"
            }
         ]
      }
   ]
}

可能的错误

  • INVALID_REQUEST_METHODHTTP 400

    请求方法不正确。
    解决方案:请使用 HTTP POST 方法调用此 API。使用其他任何请求方法都会导致此错误。

  • INVALID_DATAHTTP 400
    • 您在请求 URL 中指定了无效的记录 ID。
      解决方法:请在请求 URL 中指定有效的记录 ID。
    • 您在请求正文中指定了无效的附件 ID。
      解决方法:请在请求正文中指定有效的附件 ID。
  • MANDATORY_NOT_FOUNDHTTP 400

    您未在请求体中指定一个或多个必需键。
    解决方法:请指定所有必需键。请参阅输入 JSON部分以了解更多信息。

  • INVALID_MODULEHTTP 400

    提供的模块名称似乎无效。
    解决方案:请在请求 URL 中指定有效的模块 API 名称。

  • NOT_ALLOWEDHTTP 400

    计划时间不应是过去的时间。
    解决方案:为schedule_details 键的值指定一个未来时间。

  • AUTHENTICATION_FAILUREHTTP 401

    您尚未使用有效的访问令牌授权该 API 调用。
    解决方案:在请求头中包含有效的访问令牌,以授权该 API 调用。

  • OAUTH_SCOPE_MISMATCHHTTP 401

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

  • INVALID_URL_PATTERNHTTP 404

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

  • INTERNAL_ERRORHTTP 500

    服务器发生了意外且未处理的异常。 
    解决方案: 请通过 support@zohocrm.com 联系支持团队。

示例回复

Copied{
    "__email_drafts": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "4f8efdcbaf23fd33c939217d4e14222d2b151e840926b794ac5cfa907b76bc12"
            },
            "message": "Draft created Successfully",
            "status": "success"
        }
    ]
}