Skip to content

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

get

/email/hard_bounces

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

See me in Postman

前提条件

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

レート制限

APIレート制限に記載されているように、このエンドポイントにはBrazeのデフォルトのレート制限（1時間あたり250,000リクエスト）が適用されます。

リクエストパラメーター

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

日付範囲に 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' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE'

レスポンス

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

{
  "emails": [
    {
      "email": (string) an email that has hard bounced,
      "hard_bounced_at": (string) the time the email hard bounced in ISO 8601
    },
    {
      "email": (string) an email that has hard bounced,
      "hard_bounced_at": (string) the time the email hard bounced in ISO 8601
    },
    {
      "email": (string) an email that has hard bounced,
      "hard_bounced_at": (string) the time the email hard bounced in ISO 8601
    }
  ],
  "message": "success"
}
New Stuff!