Skip to content

配信停止メールアドレスのリストを照会

get

/email/unsubscribes

このエンドポイントを使用して、start_date から end_date までの期間に配信停止された最新のメールを返します。完全なサブスクリプション状態の履歴については、Currentsを使用してこのデータを追跡してください。

このエンドポイントを使用して、Brazeと他のメールシステムまたは独自のデータベースとの間で双方向同期を設定できます。

See me in Postman

前提条件

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

レート制限

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

リクエストパラメーター

日付範囲に limit を超える配信停止がある場合、複数のAPI呼び出しを行う必要があります。そのたびに offset を増やし、呼び出しが limit 未満またはゼロの結果を返すまで繰り返します。

リクエスト例

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/email/unsubscribes?start_date=2020-01-01&end_date=2020-02-01&limit=1&offset=1&sort_direction=desc&[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

{
  "emails": [
    {
      "email": (string) an email that has been unsubscribed,
      "unsubscribed_at": (string) the time the email was unsubscribed in ISO 8601
    },
    {
      "email": (string) an email that has been unsubscribed,
      "unsubscribed_at": (string) the time the email was unsubscribed in ISO 8601
    },
    {
      "email": (string) an email that has been unsubscribed,
      "unsubscribed_at": (string) the time the email was unsubscribed in ISO 8601
    }
  ],
  "message": "success"
}
New Stuff!