Zoho crm Logo

更新邮件草稿

目的

要更新与Zoho CRM记录关联的电子邮件草稿。您可以在一次 API 调用中更新最多 100 个电子邮件草稿。

端点

  • PUT /{module_API_name}/{record_ID}/__email_drafts

请求详情

请求URL

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

支持的模块

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

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

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

可能的模块Name

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

可能的操作类型

全部 - 完全访问所有模块
更新 - 对指定模块拥有Update权限

注意

您无法更新电子邮件草稿的库存详情。

样品请求

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

输入 JSON

  • id字符串,必填

    要更新的邮件草稿的唯一ID。

  • 发件人邮箱地址,必填

    您希望用来发送邮件的邮箱地址。

  • rich_text布尔型,必填

    请注明邮件的格式是富文本还是纯文本。可选项为: 
    true :富文本
    false:纯文本

  • reply_to电子邮件地址,可选

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

  • toJSON 数组,可选

    您希望发送邮件的用户名和电子邮件地址。如果要为多个用户创建邮件草稿,请包含多个 JSON 对象。

  • ccJSON 数组,可选

    要在发送邮件时抄送的用户名和电子邮件地址。如果要抄送多位用户,请包含多个 JSON 对象。

  • bccJSON 数组,可选

    您希望在发送邮件时抄送密件的用户名和邮箱地址。如果想要密送给多个用户,请包含多个 JSON 对象。

  • subject字符串,可选

    邮件主题

  • content字符串,可选

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

  • schedule_detailsJSON 对象,可选

    邮件的计划发送详情。请注意,此时间应设置为将来。

    • time日期时间,必填

      草稿的计划发送时间。

  • attachmentsJSON 数组,可选

    电子邮件的附件。

    • id字符串,必填

      附件的唯一 ID。

    • file_name字符串,必填

      附件的文件名。

示例输入

Copied{
   "__email_drafts":[
      {
          "id": "4f8efdcbaf23fd33c939217d4e14222d66b4d6744c35f027f42b1f303016c181",
         "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":"user3",
               "email":"user3@zylker.com"
            }
         ],
         "subject":"Test Draft update",
         "content":"this is the updated content",
         "rich_text":true,
         "template":{
            "id":"2309216000000000083"
         },
         "schedule_details":{
            "time":"2023-03-25T14:00:54+05:30",
            "timezone":"ASIA/KOLKATA"
         }
      }
   ]
}

可能的错误

  • INVALID_REQUEST_METHODHTTP 400

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

  • INVALID_DATAHTTP 400

    您在请求的URL中指定了无效的记录ID。
    解决方法:在请求的URL中指定有效的记录ID。

  • MANDATORY_NOT_FOUNDHTTP 400

    未找到必填字段。
    解决方法:您未在输入内容中指定一个或多个必填键。请填写所有必填键。有关详细信息,请参考本页面开头的输入JSON部分。

  • INVALID_MODULEHTTP 400

    您指定了无效的模块 API 名称。
    解决方法:请在请求的URL中指定有效的模块 API 名称。

  • NOT_ALLOWEDHTTP 403

    inventory_details 字段在Update草稿请求中不被允许。
    解决方法:您不能使用Update草稿 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": "4f8efdcbaf23fd33c939217d4e14222d66b4d6744c35f027f42b1f303016c181"
            },
            "message": "Draft updated Successfully",
            "status": "success"
        }
    ]
}