Skip to content

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

get

/email/unsubscribes

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

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

See me in Postman

前提条件

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

レート制限

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

リクエストパラメーター

パラメーター 必須 データタイプ 説明
start_date オプション
(注を参照)		 YYYY-MM-DD形式の文字列 配信停止を取得する範囲の開始日。end_dateより前でなければなりません。APIではUTC時間の午前0時として扱われます。
end_date オプション
(注を参照)		 YYYY-MM-DD形式の文字列 配信停止を取得する範囲の終了日。APIではUTC時間の午前0時として扱われます。
limit オプション 整数 返される結果の数を制限するためのオプションフィールドです。デフォルトは100で、最大は500です。
offset オプション 整数 取得を開始するリスト内のオプションの開始点です。
sort_direction オプション 文字列 値ascを渡すと、配信停止を古いものから新しいものへ並べ替えます。descを渡すと、新しいものから古いものへ並べ替えます。sort_directionが含まれていない場合、デフォルトの順序は新しいものから古いものです。
email オプション
(注を参照)		 文字列 指定すると、そのユーザーが配信停止しているかどうかを返します。

日付範囲に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!