Skip to content

ハードバウンスされたメールのクエリ

get

/email/hard_bounces

このエンドポイントを使用して、”hard bounced”を持つメールアドレスのリストをプルします。特定の時間内にメールメッセージをプルします。

See me in Postman

前提条件

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

レート制限

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.

要求パラメータ

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

日付範囲にlimit 個以上のハードバウンスがある場合は、offset を増やすたびにlimit またはゼロのいずれかの結果が返されるまで、複数のAPI 呼び出しを実行する必要があります。offset およびlimit パラメータをemail とともに含めると、空の応答を返すことができます。

リクエスト例

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=example@braze.com' \
--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"
}
  Edit this page on GitHub
HOW HELPFUL WAS THIS PAGE?
New Stuff!