发送邮件
您只能向 Zoho CRM 中其他记录的电子邮件ID发送电子邮件
- 未在设置中配置电子邮件: Emails 可以从您账户的主要电子邮件和组织的电子邮件地址发送。
- 使用配置的邮件(IMAP/POP/Gmail): Emails可以从配置的电子邮件地址、电子邮件别名以及组织的电子邮件地址发送。
请参考 Zoho 邮件设置 了解如何为您的账户设置电子邮件。
目的
通过 API 向记录的电子邮件 ID 发送电子邮件。
- POST /{module_API_name}/{record_ID}/actions/send_mail
请求详情
请求 URL
全部 - {api-domain}/crm/{version}/{module_api_name}/{record_id}/actions/send_mail
支持的模块
潜在客户、联系人、交易、账户、销售订单、采购订单、发票、报价单、案例、供应商和自定义。
标题
授权:Zoho-oauthtoken <access_token>
范围
ZohoCRM.send_mail.{module_name}.CREATE
(或)ZohoCRM.send_mail.all.CREATE
可能的模块名称
潜在客户、账户、联系人、交易、报价、销售订单、采购订单、发票、案例和自定义
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Leads/3652397000002181001/actions/send_mail"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"请求 JSON
- fromJSON 对象,必填项
表示发件人的姓名和电子邮件地址。
- toJSON 数组,必选
用户姓名和电子邮件地址,这是您想要发送邮件的对象。如果您想要向多位用户发送邮件,请包含多个 JSON 对象。
- ccJSON 数组,可选
当你发送邮件时想要抄送的用户名和电子邮件地址。如果你想抄送给多个用户,可以包含多个 JSON 对象。
- bccJSON 数组,可选
在发送电子邮件时您想密送的用户名和电子邮件地址。如果要密送多个用户,请包括多个 JSON 对象。
- reply_toJSON 对象,可选
您希望用户在收到邮件后回复的用户名和电子邮件地址。
- org_emailBoolean,可选
值为 true 表示邮件是从组织的电子邮件地址发送的。请注意,当您将此值设置为 true 时,邮件将通过 Zoho CRM 的服务器发送,而不是通过您配置的 SMTP 服务器发送。默认值为 false。
- in_reply_to JSON 对象,可选
仅在您回复电子邮件时输入此键。请注意,当您的邮箱通过 IMAP 或 POP 集成同步时,所有邮件回复默认将形成“线程视图”。
- message_id 字符串,必填
它代表之前邮件(您之前发送的邮件)的 message_ID。
- owner 字符串,可选
通过提供新用户的唯一 ID,使用此键将新用户更改为邮件的接收者。
- scheduled_timeDateTime 以 ISO8601 格式,可选
仅当您想要安排电子邮件时输入此键。 日期和时间必须采用 ISO8601 格式。
- subjectString,可选
电子邮件的主题。
- mail_formatString, 可选
电子邮件的格式,例如纯文本或富文本。值 html 表示富文本格式,text 表示纯文本格式。
- contentString,可选
在使用文件 API上传文件到ZFS时获得的加密ID。如果您想附加多个文件,请包含多个JSON对象。
- templateJSON 对象,可选
模板的唯一 ID,来自该模板的主题、内容和附件将被包含在电子邮件中。如果您指定了模板 ID,并包含键“subject”、“content”、“attachments”,这些键中的值才会被考虑。
示例输入
Copied{
"data": [
{
"from": {
"user_name": "Patricia Boyle",
"email": "p.boyle@zoho.com"
},
"to": [
{
"user_name": "Jason Smith",
"email": "j.smith@zoho.com"
}
],
"cc": [
{
"user_name": "user3",
"email": "user3email@zoho.com"
}
],
"bcc": [
{
"user_name": "user4",
"email": "user4email@zoho.com"
}
],
"reply_to": {
"user_name": "user5",
"email": "user5email@zoho.com"
},
"org_email": false,
"in_reply_to": {
"message_id": "c7e44db11d67a68aec57814b5c9a6edf29c64701ed4dc3e5603a274071f846da4c55f352740772f45db0e2aaea68527b",
"owner": {
"id": "2423488000000483001"
}
},
"scheduled_time": "2021-06-12T12:12:12+05:30",
"subject": "Testing Send Mail API",
"content": "<h3><span style=\"background-color: rgb(254, 255, 102)\">Mail is of rich text format</span></h3><h3><span style=\"background-color: rgb(254, 255, 102)\"><img src=\"https://www.zohoapis.com/crm/viewInLineImage?fileContent=2cceafa194d037b63f2000181dd818646fd5e5167a274098b625c35654a20ed2\"></span></h3><h3><span style=\"background-color: rgb(254, 255, 102)\">REGARDS,</span></h3><div><span style=\"background-color: rgb(254, 255, 102)\">AZ</span></div><div><span style=\"background-color: rgb(254, 255, 102)\">ADMIN</span></div> <div></div>",
"mail_format": "html",
"attachments": [
{
"id": "2cceafa194d037b63f2000181dd81864b4812b1f8b0b4fe0949a982de89fa75a"
}
],
"template": {
"id": "3652397000002497001"
}
}
]
}示例响应
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"message_id": "2cceafa194d037b63f2000181dd8186486f1eb0360aee76d802b6d376dea22e2"
},
"message": "Your mail has been scheduled successfully.",
"status": "success"
}
]
}请求JSON以发送电子邮件到库存模块
对于库存模块(报价、销售订单、采购订单、发票),库存模板将作为电子邮件附件发送。
- inventory_detailsJSON 对象, 必填
表示库存模板的详细信息,例如模板 ID、纸张类型和视图类型。
- inventory_template JSON 对象,必填
您想在电子邮件中使用的库存模板的唯一 ID和模板名称。
- paper_typeString,可选
数字打印的纸张类型。可能的值为default、A4和us_letter。默认值为A4。
- view_type字符串,可选
您希望查看模板的方式。可能的值为纵向和横向。默认值为纵向。
从库存模块发送电子邮件的示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Purchase_Orders/3652397000000491180/actions/send_mail"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"示例输入
Copied{
"data": [
{
"from": {
"user_name": "Patricia Boyle",
"email": "p.boyle@abc.com"
},
"to": [
{
"user_name": "user1",
"email": "user1@gmail.com"
}
],
"inventory_details": {
"inventory_template": {
"id": "3652397000000187009",
"name": "CT Scan Machines.pdf"
},
"paper_type": "A4",
"view_type": "portrait"
}
}
]
}示例响应
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"message_id": "2cceafa194d037b63f2000181dd8186468a4f140fd300509994fb12dd4c97e67"
},
"message": "Your mail has been sent successfully.",
"status": "success"
}
]
}请求与GDPR相关的数据JSON
在您启用了GDPR合规设置并希望发送电子邮件以请求用户同意或请求数据时,请使用以下键。请注意,当您请求潜在客户/联系人的同意时,必须在电子邮件的“content”键中发送同意表单。
- consent_email布尔值,当您希望请求接收方的同意时为必填项
值true表示邮件是同意邮件。默认值为false。
- data_subject_requestJSON对象,可选
数据主体请求的唯一ID和“type”键。
“type”键取以下值之一。- access - 表示数据主体可以通过发送包含个人字段信息的电子邮件来查看其个人数据。
- rectify - 表示数据主体可以通过发送包含个人信息的.CSV文件并手动更新更改来修改个人字段。
- export - 表示数据主体将有其个人数据的.CSV格式副本,可在其他系统中使用。
发送 GDPR 相关数据的示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Leads/3652397000002181001/actions/send_mail"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"示例输入
Copied{
"data": [
{
"from": {
"user_name": "Patricia Boyle",
"email": "p.boyle@abc.com"
},
"to": [
{
"user_name": "user1",
"email": "user1email@zoho.com"
}
],
"subject": "Mail subject",
"content": "<br><a href=\"${ConsentForm.en_US}\" id=\"ConsentForm\" class=\"en_US\" target=\"_blank\">Consent form link</a><br><br><br><br><br><h3><span style=\"background-color: rgb(254, 255, 102)\">REGARDS,</span></h3><div><span style=\"background-color: rgb(254, 255, 102)\">AZ</span></div><div><span style=\"background-color: rgb(254, 255, 102)\">ADMIN</span></div> <div></div>",
"consent_email": true,
"mail_format": "html",
"data_subject_request": {
"id": "482134000000568909",
"type": "access"
}
}
]
}示例响应
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"message_id": "2cceafa194d037b63f2000181dd8186468a4f140fd300509994fb12dd4c97e67"
},
"message": "Your mail has been sent successfully.",
"status": "success"
}
]
}可能的错误
- MANDATORY_NOT_FOUND HTTP 400
输入中缺少发件人或收件人的电子邮箱地址。
解决方案: 使用输入中缺少详细信息的 "parent_api_name" 键。对于发件人的电子邮箱地址,通过 这个 API 获取允许的 "from" 地址列表。 - LIMIT_EXCEEDED HTTP 400
您已经超出了每天发送100封电子邮件的最大限制。
解决方案:请在第二天发送电子邮件或联系support@zohocrm.com以增加您的限制。 - NOT_ALLOWED HTTP 400
您的版本不支持此功能。
解决方案:联系您的管理员。 - NOT_ALLOWED HTTP 400
预期的接收者未同意接收您的电子邮件。
解决方法:根据 GDPR 合规性,每个潜在客户/联系人必须同意接收电子邮件。请发送同意表格并获得他们的同意后再发送电子邮件。 - NOT_ALLOWED HTTP 400
目标接收者已选择停止电子邮件通信。
解决方法:根据 GDPR 合规性规定,每个潜在客户/联系人必须同意接收电子邮件。请向他们发送同意表,并获得他们的同意以发送电子邮件。 - NOT_ALLOWED HTTP 400
记录没有主要或次要电子邮件地址。
解决方法:相关联系人在交易模块中没有电子邮件地址。请在交易模块中添加主要、次要或自定义电子邮件地址以发送电子邮件。 - NOT_ALLOWED HTTP 400
来自记录的电子邮件地址或收件人电子邮件地址的电子邮件被退回,因此被阻止。
解决办法:请参阅响应中的“details”键,了解哪个电子邮件地址被阻止。联系 support@zohocrm.com。 - INVALID_DATA HTTP 400
请求中的记录ID无效。
解决方法:提供有效的记录ID。 - INVALID_DATA HTTP 400
您不能使用此邮箱地址发送邮件。
解决方法: 您只能从允许的“发件人”地址列表发送邮件。 - INVALID_DATA HTTP 400
记录的合规设置未启用。
解决方案:在发送带有同意表格的电子邮件之前,您必须为该记录启用合规设置和数据处理。 - INVALID_DATA HTTP 400
您提供了附件的错误加密ID。
解决方法:请参考 "details" 键以了解哪个键的输入不正确。 - FILE_SIZE_EXCEEDS HTTP 400
附件的总大小已经超过了10 MB。
解决方法:您可以在邮件中包含多个附件,但附件的总大小不得超过10 MB。 - CUSTOM_ERROR HTTP 400
连接到SMTP服务器时发生错误。
解决方案:确保在电子邮件配置中提供正确的凭据或重新登录。 - FEATURE_NOT_SUPPORTED HTTP 400
您的版本不支持发送定时电子邮件。
解决方法:此功能在试用版和免费版中不可用。请联系您的管理员。 - RECORD_LOCKED HTTP 400
您无法执行此操作,因为记录已被锁定。
解决方法: 请等待记录解锁。 - NO_PERMISSION HTTP 403
您已为该记录启用“邮件退出”。
解决方法:禁用“邮件退出”以发送电子邮件。 - NO_PERMISSION HTTP 403
您还没有确认您的账户。
解决方法:确认已注册的账户以发送邮件。 - NO_PERMISSION HTTP 403
您尚未确认与您的账户关联的电子邮件。
解决办法:确认注册的电子邮件。