メールテンプレートを一覧表示

GET /v1/email-templates · 権限 email-templates:read

カスタマイズ可能なすべてのメールファミリーを、プランの順序で、バージョンのあるロケールとともに返します。一覧は固定で、ページ分割されません（list_metadata のカーソルは常に null）。読み取りはすべてのプランで利用できます。

各ファミリーは、テンプレートに何を含めるべきかを示します:

security: プラットフォームがセキュリティブロックを追加します。テンプレートはこれを削除できません。
requires: メッセージの HTML 本文とプレーンテキスト本文の両方に表示する必要がある値: code、link、code_or_link または none。
available: false の場合、このリリースではそのファミリーのシステムテンプレートがまだないことを意味し、下書きは拒否されます。
variables: テンプレートで使用できる Liquid 変数。

レスポンス

200 OK

{
  "data": [
    {
      "family": "verify_email",
      "security": false,
      "requires": "code_or_link",
      "available": true,
      "variables": ["application.name", "code", "dir", "environment.display_name", "expires_in_minutes", "link", "locale", "support_url", "user.email"],
      "locales": [{"locale": "en", "latest_version": 3, "published_version": 2}]
    }
  ],
  "list_metadata": {"before": null, "after": null}
}

エラー

HTTP	code	発生条件
401	`unauthenticated`	資格情報がない、無効、または取り消されています。
403	`insufficient_permissions`	資格情報に必要な権限がありません。
429	`rate_limited`	レート制限を超えました。`Retry-After` の期間が過ぎてから再試行してください。
503	`service_unavailable`	依存先が一時的に利用できません。`Retry-After` の期間が過ぎてから再試行してください。

例

curl https://api.eu.keenauth.com/v1/email-templates \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"

CLI: keenauth email-templates list