ハードバウンスメールの照会
get
/email/hard_bounces
このエンドポイントを使用して、一定期間内にメールメッセージを「ハードバウンス」したメールアドレスのリストを取得します。
前提条件
このエンドポイントを使用するには、email.hard_bounces
権限を持つ API キーが必要です。
レート制限
API レート制限で説明されているように、このエンドポイントにはデフォルトの1時間あたり25万リクエストのBraze レート 制限が適用されます。
リクエストパラメーター
パラメーター | required | データ型 | 説明 |
---|---|---|---|
start_date |
オプション (注を参照) |
YYYY-MM-DD形式の文字列 | ハードバウンドを取得する範囲の開始日であり、end_date より前である必要があります。これは API によって UTC 時間の真夜中として扱われます。 |
end_date |
オプション (注を参照) |
YYYY-MM-DD形式の文字列 | ハードバウンスを取得する範囲の終了日。これは API によって UTC 時間の真夜中として扱われます。 |
limit |
オプション | 整数 | 返される結果の数を制限するためのオプション・フィールド。デフォルトは100で、最大は500です。 |
offset |
オプション | 整数 | 取得先となるリスト内のオプションの開始点。 |
email |
オプション (注を参照) |
string | 指定されると、ユーザーがハードバウンスしたかどうかを返します。Eメールの文字列が正しくフォーマットされているか確認する。 |
note:
start_date
とend_date
、または email
のいずれかを指定する必要があります。start_date
、end_date
、email
の3つすべてを指定した場合、指定されたメールを優先し、日付の範囲は無視します。
日付範囲に limit
の数を超えるハードバウンスがある場合、複数回の API 呼び出しが必要になります。呼び出しによって返されるのが limit
を下回るか、結果がゼロになるまで、その都度 offset
を増やします。email
とともに offset
および limit
パラメーターを含めると、空の応答が返されることがあります。
リクエスト例
1
2
curl --location --request GET 'https://rest.iad-01.braze.com/email/hard_bounces?start_date=2019-01-01&end_date=2019-02-01&limit=100&offset=1&[email protected]' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE'
応答
エントリーは降順で表示される。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"emails": [
{
"email": (string) an email that has hard bounced,
"unsubscribed_at": (string) the time the email hard bounced in ISO 8601
},
{
"email": (string) an email that has hard bounced,
"unsubscribed_at": (string) the time the email hard bounced in ISO 8601
},
{
"email": (string) an email that has hard bounced,
"unsubscribed_at": (string) the time the email hard bounced in ISO 8601
}
],
"message": "success"
}
New Stuff!