利用可能なメールテンプレートの一覧表示
get
/templates/email/list
このエンドポイントを使用して、Braze アカウントで使用可能なメールテンプレートのリストを取得します。
前提条件
このエンドポイントを使用するには、templates.email.list
権限を持つAPI キー が必要です。
レート制限
We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.
要求パラメータ
パラメータ | 必須 | データ型 | 説明 |
---|---|---|---|
modified_after |
オプション | ISO-8601 形式の文字列 | 指定した時刻以降に更新されたテンプレートのみを取得します。 |
modified_before |
オプション | ISO-8601 形式の文字列 | 指定した時刻またはそれ以前に更新されたテンプレートのみを取得します。 |
limit |
オプション | 正の数 | 取得するテンプレートの最大数。指定されていない場合は、デフォルトで100、許容可能な最大値は1000 です。 |
offset |
オプション | 正の数 | 検索条件に一致する残りのテンプレートを返す前にスキップするテンプレートの数 |
リクエスト例
1
2
curl --location --request GET 'https://rest.iad-01.braze.com/templates/email/list?modified_after=2020-01-01T01:01:01.000000&modified_before=2020-02-01T01:01:01.000000&limit=1&offset=0' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'
レスポンス
important:
メールのドラッグアンドドロップエディタを使用して作成されたテンプレートは、このレスポンスでは提供されません。
1
2
3
4
5
6
7
8
9
10
11
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
"count": the number of templates returned
"templates": [template with the following properties]:
"email_template_id": (string) your email template's API Identifier,
"template_name": (string) the name of your email template,
"created_at": (string) the time the email was created at in ISO 8601,
"updated_at": (string) the time the email was updated in ISO 8601,
"tags": (array of strings) tags appended to the template
}