Sugarcrm支持产品指南糖开发人员糖开发人员指南11.0一体化网页服务休息API.终点/邮件帖子

/邮件帖子

概述

创建电子邮件并发送或保存为草稿。

查询字符串参数

此端点不接受任何查询字符串参数。

输入参数

名称 类型 描述 必需的
email_config String 发送此电子邮件时要使用的出站电子邮件配置的ID True
to_addresses Array 名称/电子邮件地址对为字段的数组,当存在时,只需要电子邮件子字段(不是名称)。 True
cc_addresses Array CC字段的名称/电子邮件地址对数组,当前时,需要电子邮件子字段。 False
bcc_addresses Array 姓名/电子邮件地址对的数组BCC字段,当前时,需要电子邮件子场。 False
subject String Subject of the email False
html_body String 电子邮件的HTML正文 False
text_body String 电子邮件的文本正文 False
status String 表示电子邮件的状态 - '草案'或'准备'(已准备好发送) True
related Object 包含'parent_type'和'parent_id'以将此电子邮件与(例如“联系人”和联系人的ID相关联) False
teams Object 将此电子邮件分配给团队。 '主'属性是主要团队的ID字符串,“其他”属性是其他团队的ID字符串数组 - 仅需要主要是主要的 True
attachments Array 文件附件数组 - 每个附件由“类型”(附件来自:上传,文档或模板),'id'(文件上传,注意,文档修订版等)和“名称”(文件名)) False

输入示例

{
  "Email_Config":"abc181a2-5c05-b879-8e68-502279a8c401",
  "to_addresses.":[
    {
      "name":"John Doe",
      "email":"john_doe@foo.com"
    },
    {
      "name":"David Madison",
      "email":"david_madison@bar.com"
    }
  ],
  "cc_addresses.":[
    {
      "name":"Tom Swift",
      "email":"tswift@baz.com"
    }
  ],
  "bcc_addresses.":null,
  "主题":"Minneapolis Convention",
  "HTML_BODY.":"<html><body>Hello World<\/body><\/html>",
  "text_body.":"Hello World"
  "地位":"ready",
  "有关的": {
    "type":"Contacts",
    "id":"61cf0f8d-938c-c9b2-53ad-51ed7bbcf83b"
  },
  "队": {
    "primary": "dabec868-696c-f458-e204-50227995ab50",
    "others": [
      "c3094c88-c95f-2e17-4553-50227996ad20",
      "abcde868-696c-f458-e704-58369095ab62"
    ]
  },
  "附件": [
    {
       "type": "upload",
       "id": "cfbe4551-548d-f602-b228-45387645fc12",
       "name": "company_logo.jpg"
    },
    {
       "type": "document",
       "id": "876112a4-89c1-4ba7-a05a-7729a7a76818"
    },
    {
       "type": "template",
       "id": "002cfe6c-98e9-4342-bdb1-1660d0788872"
    }
  ],
}

结果

名称 类型 描述
<email record field> <电子邮件记录字段类型> 返回新创建的电子邮件记录的字段。

输出示例

{
    "team_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
    "team_set_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
    "id": "d9c165d0-8863-ba61-dc85-51ed8016c476",
    "date_entered": "2013-07-22 18:57:57",
    "date_modified": "2013-07-22 18:57:57",
    "assigned_user_id": "1",
    "assigned_user_name": "",
    "modified_user_id": "1",
    "modified_by_name": "admin",
    "created_by": "1",
    "created_by_name": "",
    "deleted": 0,
    "from_addr_name": "SugarCRM",
    "reply_to_addr": "",
    "to_addrs_names": "john_doe@foo.com, david_madison@bar.com",
    "cc_addrs_names": "tswift@baz.com",
    "description_html": "<html><body>Hello World<\/body><\/html>",
    "description": "Hello World",
    "date_sent": "2013-07-22 18:57:00",
    "name": "Minneapolis Convention",
    "type": "out",
    "地位": "sent",
    "parent_type": "Contacts",
    "parent_id": "61cf0f8d-938c-c9b2-53ad-51ed7bbcf83b",
}

更改日志

版本 改变
v11 Last version in which /Mail POST is available. Use /Emails POST instead.
v10 Added /Mail POST endpoint.

最后修改:2021-02-17 02:44:13