Eメールテンプレートを作成する

post

/templates/email/create

BrazeダッシュボードでEメールテンプレートを作成するには、このエンドポイントを使用する。

これらのテンプレートは、「テンプレート＆メディア」ページで利用できるようになる。このエンドポイントからのレスポンスには、email_template_id のフィールドが含まれ、以降のAPIコールでテンプレートを更新するために使用できる。

ユーザーのメールサブスクリプションステータスは、RESTful API を使って Braze 経由で更新・取得できます。APIを使用して、Brazeと他のメールシステムまたは独自のデータベースとの双方向同期を設定できる。すべてのAPIリクエストはHTTPSで行われる。

See me in Postman

前提条件

このエンドポイントを使用するには、templates.email.create 権限を持つ API キーが必要です。

レート制限

API レート制限で説明されているように、このエンドポイントにはデフォルトの1時間あたり25万リクエストのBraze レート制限が適用されます。

Request body

Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY

{
   "template_name": (required, string) The name of your email template,
   "subject": (required, string) The email template subject line,
   "body": (required, string) The email template body that may include HTML,
   "plaintext_body": (optional, string) A plaintext version of the email template body,
   "preheader": (optional, string) The email preheader used to generate previews in some clients,
   "tags": (optional, Array of Strings) Tags must already exist,
   "should_inline_css": (optional, Boolean) If `true`, the `inline_css` feature is used on this template.
 }

リクエストパラメーター

パラメーター	required	データ型	説明
`template_name`	必須	string	メールテンプレートの名前
`subject`	必須	string	メールテンプレートの件名
`body`	必須	string	HTMLを含む可能性のあるメールテンプレート本文。
`plaintext_body`	オプション	string	メールテンプレート本文のプレーンテキストバージョン。
`preheader`	オプション	string	一部のクライアントでプレビューを生成するために使用されるメールプレヘッダー。
`tags`	オプション	string	タグはすでに存している必要があります。
`should_inline_css`	オプション	ブール値	テンプレートごとに`inline_css` 機能を有効または無効にする。提供されない場合、Brazeはアプリグループのデフォルト設定を使用する。`true` か`false` のどちらかが予想される。

リクエスト例

curl --location --request POST 'https://rest.iad-01.braze.com/templates/email/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
  "template_name": "email_template_name",
  "subject": "Welcome to my email template!",
  "body": "This is the text within my email body and https://www.braze.com/ here is a link to Braze.com.",
  "plaintext_body": "This is the text within my email body and here is a link to https://www.braze.com/.",
  "preheader": "My preheader is pretty cool.",
  "tags": ["Tag1", "Tag2"]
}'

考えられるエラー

以下の表は、返される可能性のあるエラーと、該当する場合、それに関連するトラブルシューティングの手順を示している。

エラー	トラブルシューティング
テンプレート名は必須	テンプレート名を入力する。
タグは配列でなければならない	タグは文字列の配列としてフォーマットされなければならない。例えば、`["marketing", "promotional", "transactional"]` 。
タグはすべて文字列でなければならない	タグが引用符 (`""`) で囲まれていることを確認すること。
いくつかのタグが見つからない	Eメールテンプレート作成時にタグを追加するには、そのタグがすでにBrazeに存在している必要がある。
Eメールには有効なコンテンツ・ブロック名が必要である	メールには、この環境には存在しないコンテンツ・ブロックが含まれている可能性がある。
`should_inline_css` の値が無効である。`true` または`false` のどちらかが予想された	このパラメータはブーリアン値（trueまたはfalse）のみを受け付ける。`should_inline_css` の値が引用符（`""` ）で囲まれていないことを確認すること。この場合、値は文字列として送信される。

GitHub でこのページを編集

「このページはどの程度役に立ちましたか?」

GitHub でこのページを編集

New Stuff!