Skip to content

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

get

/email/hard_bounces

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

See me in Postman

前提条件

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

レート制限

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

リクエストパラメーター

日付範囲に 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"
}
Github   GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!