Skip to content

ハードバウンスメールの照会

get

/email/hard_bounces

このエンドポイントを使用して、一定期間内にメールメッセージを「ハードバウンス」したメールアドレスのリストを取得します。

前提条件

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

レート制限

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

リクエストパラメーター

パラメーター required データ型 説明
start_date オプション
(注を参照)
YYYY-MM-DD形式の文字列 ハードバウンドを取得する範囲の開始日であり、end_date より前である必要があります。これは、API によって UTC 時間の午前 0 時として扱われます。
end_date オプション
(注を参照)
YYYY-MM-DD形式の文字列 ハードバウンスを取得する範囲の終了日。これは、API によって UTC 時間の午前 0 時として扱われます。
limit オプション 整数 返される結果の数を制限するためのオプション・フィールド。デフォルトは100で、最大は500です。
offset オプション 整数 取得先となるリスト内のオプションの開始点。
email オプション
(注を参照)
文字列 指定されると、ユーザーがハードバウンスしたかどうかを返します。Eメールの文字列が正しくフォーマットされているか確認する。

日付範囲に limit の数を超えるハードバウンスがある場合、複数回の API 呼び出しが必要になります。呼び出しによって返されるのが limit を下回るか、結果がゼロになるまで、その都度 offset を増やします。email とともに offset および limit パラメーターを含めると、空の応答が返されることがあります。

例のリクエスト

応答

エントリは降順で表示されます。

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