ユーザーのサブスクリプショングループをリストする

このエンドポイントを使用して、特定のユーザーのサブスクリプショングループを一覧表示および取得します。

例を見たり、このエンドポイントをテストしたりする場合は、メールサブスクリプショングループをご覧ください。

SMSサブスクリプショングループ用のこのエンドポイントをテストするか例を見たい場合:

このエンドポイントの例を見たり、WhatsAppグループをテストしたりする場合:

前提条件

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

レート制限

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

リクエストパラメーター

例のリクエスト

• 複数のユーザー
• smsとwhatsapp
• メール

1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/user/status?external_id={{external_id}}&limit=100&offset=1&phone=+11112223333' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/user/status?external_id={{external_id}}&[email protected]&limit=100&offset=0' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

応答の例

1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "success": true,
  "subscription_groups": [
    {
      "subscription_group_id": "group_id_1",
      "subscription_status": "subscribed"
    },
    {
      "subscription_group_id": "group_id_2",
      "subscription_status": "unsubscribed"
    }
  ]
}