Skip to content

配信停止になっているメールアドレスのリストの照会

get

/email/unsubscribes

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

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

前提条件

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

レート制限

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

リクエストパラメーター

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

日付範囲に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
18
19
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "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!