发信

托管模板

创建带类型的草稿、预览精确输出、发布不可变的版本,并保留发送溯源信息。

生命周期

每个模板都有一个稳定的 ID 和 key、一份可编辑的草稿、零个或多个不可变的已发布版本,以及活跃或已归档两种生命周期状态。归档后将无法再按 key 发起新的发送,但不会删除历史版本或使用记录。

变量

为变量声明 key、类型、是否必填以及可选的默认值。当传入的数据不满足已发布的约定时,渲染会以 422 失败。插入的值会根据上下文进行转义。

乐观自动保存

每份草稿都带有一个修订号。请将当前修订号发送到 PUT /templates/:id/draft。如果其他编辑者先保存了,SendHQ 会返回 409;请重新加载后再覆盖。

预览、测试、发布

  1. 使用有代表性的示例数据进行渲染。
  2. 解决所有错误级别的检查结果。
  3. 向您控制的地址发送一份测试快照。
  4. 将当前草稿原样发布为不可变的版本。

按 key 发送

POST /emails 请求体
{
  "from": "hello@example.com",
  "to": [
    "customer@example.net"
  ],
  "template": {
    "key": "account-welcome",
    "data": {
      "first_name": "Asha"
    }
  }
}

个性化模板发送要求恰好一个 To 收件人,且不能有 Cc 或 Bcc。如需向多个收件人发送个性化内容,请使用批量端点。

溯源

每次模板发送都会记录模板、版本、编译器版本和渲染内容的哈希值,因此任何一封历史邮件都可以追溯到生成它的内容。