认证与请求头

使用应用 API Key 调用。当前接口只校验上方独立 Scope；读取、管理与执行权限互不隐含。

名称	位置	类型	必填	说明	示例
`Authorization`	header	string	是	应用 API Key，使用 Bearer 方式传递。	`Bearer qwk_***`
`X-Request-Id`	header	string	否	可选的调用追踪标识；未传入时由服务端生成。	`req-20260831-001`

请求参数

名称	位置	类型	必填	说明	示例
`template_id`	path	`string`	必填	`-`	`"<string>"`
`html`	body	`string`	必填	`-`	`"<string>"`
`subject`	body	`string`	必填	`-`	`"<string>"`
`text`	body	`string`	必填	`-`	`"<string>"`
`version`	body	`integer · int64`	必填	`-`	`0`

请求示例

cURL

curl --request PUT \
  --url '<BASE_URL>/api/openapi/v1/mail-templates/<template_id>' \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "html": "<string>",
  "subject": "<string>",
  "text": "<string>",
  "version": 0
}'

响应

200 OK

名称	类型	必填	说明	示例
`customized`	`boolean`	是	`-`	`false`
`default`	`OpenapifacadeMailContent`	是	`-`	`{"html":"<string>","subject":"<string>","text":"<string>"}`
`default.html`	`string`	是	`-`	`"<string>"`
`default.subject`	`string`	是	`-`	`"<string>"`
`default.text`	`string`	是	`-`	`"<string>"`
`id`	`string`	是	`-`	`"<string>"`
`source`	`OpenapifacadeMailContent`	是	`-`	`{"html":"<string>","subject":"<string>","text":"<string>"}`
`source.html`	`string`	是	`-`	`"<string>"`
`source.subject`	`string`	是	`-`	`"<string>"`
`source.text`	`string`	是	`-`	`"<string>"`
`updated_at`	`string · date-time`	否	`-`	`"2026-08-27T10:00:00Z"`
`using_legacy_default`	`boolean`	是	`-`	`false`
`variable_definitions`	`array \| null`	是	`-`	`[{"code":"<string>","display_name":"<string>","example":"<string>","max":0,"max_length":0,"min":0,"pattern":"<string>","purpose":"<string>","rendered":false,"required":false,"type":"<string>"}]`
`version`	`integer · int64`	是	`-`	`0`

响应示例

{
  "customized": false,
  "default": {
    "html": "<string>",
    "subject": "<string>",
    "text": "<string>"
  },
  "id": "<string>",
  "source": {
    "html": "<string>",
    "subject": "<string>",
    "text": "<string>"
  },
  "updated_at": "2026-08-27T10:00:00Z",
  "using_legacy_default": false,
  "variable_definitions": [
    {
      "code": "<string>",
      "display_name": "<string>",
      "example": "<string>",
      "max": 0,
      "max_length": 0,
      "min": 0,
      "pattern": "<string>",
      "purpose": "<string>",
      "rendered": false,
      "required": false,
      "type": "<string>"
    }
  ],
  "version": 0
}

default Flat business error

名称	类型	必填	说明	示例
`code`	`string`	否	Stable business error code	`"<string>"`
`detail`	`string`	是	Human-readable error description	`"<string>"`
`details`	`OpenapiErrorDetails`	否	`-`	`{"field":"<string>","reason":"<string>","suggestion":"<string>"}`
`details.field`	`string`	否	Request field that failed validation	`"<string>"`
`details.reason`	`string`	否	Stable validation failure reason	`"<string>"`
`details.suggestion`	`string`	否	Suggested normalized value	`"<string>"`
`error`	`string`	是	Stable HTTP error type	`"<string>"`

响应示例

{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}