API 参考

托管模板

起草、渲染、测试、版本管理、发布和发送可复用的内容。

筛选托管模板接口

GET/templates

API 密钥

列出托管模板

查询参数lifecyclequery

请求

curl https://sendhq.cc/api/v1/templates \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

200 响应

{
  "data": [],
  "count": 0
}

POST/templates

API 密钥

创建托管模板

请求

curl https://sendhq.cc/api/v1/templates \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Account welcome","key":"account-welcome","starter":"welcome"}'

201 响应

{
  "template": {
    "id": "tmpl_…",
    "key": "account-welcome"
  }
}

GET/templates/:id

API 密钥

获取草稿、版本和使用情况

请求

curl https://sendhq.cc/api/v1/templates/id_value \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

200 响应

{
  "template": {
    "id": "tmpl_…"
  },
  "versions": [],
  "draft": null,
  "activeVersion": null,
  "usage": []
}

PUT/templates/:id/draft

API 密钥

自动保存模板草稿

请求

curl https://sendhq.cc/api/v1/templates/id_value/draft \
  -X PUT \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"revision":1,"name":"Account welcome","subjectTemplate":"Welcome, {{first_name}}","htmlTemplate":"<h1>Welcome, {{first_name}}</h1>","textTemplate":"Welcome, {{first_name}}","variables":[{"key":"first_name","type":"string","required":true}],"sampleData":{"first_name":"Asha"}}'

200 响应

{
  "draft": {
    "id": "tmplv_…",
    "revision": 2
  }
}

POST/templates/:id/draft

API 密钥

基于已发布版本创建新草稿

请求

curl https://sendhq.cc/api/v1/templates/id_value/draft \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

201 响应

{
  "draft": {
    "id": "tmplv_…",
    "revision": 1
  }
}

POST/templates/:id/render

API 密钥

渲染与服务端完全一致的输出

请求

curl https://sendhq.cc/api/v1/templates/id_value/render \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data":{"first_name":"Asha"}}'

200 响应

{
  "subject": "Welcome, Asha",
  "html": "<h1>Welcome, Asha</h1>",
  "text": "Welcome, Asha",
  "findings": []
}

POST/templates/:id/test

API 密钥

发送测试快照

请求

curl https://sendhq.cc/api/v1/templates/id_value/test \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":["owner@example.com"],"from":"hello@example.com","data":{"first_name":"Asha"}}'

201 响应

{
  "id": "em_…",
  "isTest": true
}

POST/templates/:id/publish

API 密钥

发布不可变的模板版本

请求

curl https://sendhq.cc/api/v1/templates/id_value/publish \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

201 响应

{
  "version": {
    "id": "tmplv_…",
    "state": "published"
  }
}

POST/templates/:id/archive

API 密钥

归档模板

请求

curl https://sendhq.cc/api/v1/templates/id_value/archive \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

200 响应

{
  "template": {
    "id": "tmpl_…",
    "lifecycle": "archived"
  }
}

POST/templates/:id/restore

API 密钥

恢复已归档的模板

请求

curl https://sendhq.cc/api/v1/templates/id_value/restore \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

200 响应

{
  "template": {
    "id": "tmpl_…",
    "lifecycle": "active"
  }
}