ホスト型テンプレート

ライフサイクル

テンプレートには、一定のIDとキー、編集可能な下書き1つ、0個以上の変更不可の公開済みリリース、そして有効またはアーカイブ済みのライフサイクルがあります。アーカイブすると、過去のリリースや使用履歴を削除することなく、キーによる新規送信を防げます。

変数

変数は、キー、型、必須かどうか、任意のデフォルト値を指定して宣言します。渡されたデータが公開済みの仕様を満たさない場合、レンダリングは422で失敗します。挿入される値はコンテキストに応じてエスケープされます。

楽観的な自動保存

各下書きにはリビジョンがあります。PUT /templates/:id/draftには現在のリビジョンを送信してください。別の編集者が先に保存していた場合、SendHQは409を返します。上書きする前に再読み込みしてください。

プレビュー、テスト、公開

1. 代表的なサンプルデータでレンダリングします。
2. すべてのエラー項目を解消します。
3. 管理しているアドレスにテスト用スナップショットを送信します。
4. その下書きをそのまま変更不可のリリースとして公開します。

キーで送信する

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

個別化したテンプレートの送信には、To受信者がちょうど1人で、CcとBccがないことが必要です。受信者ごとに個別化する場合は一括送信のエンドポイントを使ってください。

来歴

テンプレートを使った送信ではすべて、テンプレート、リリース、コンパイラのバージョン、レンダリングされた内容のハッシュが記録されるため、過去のメッセージをそれを生成した内容までさかのぼって追跡できます。