ユーザーの購読グループ一覧
get
/subscription/user/status
このエンドポイントを使用して、特定のユーザーのサブスクリプショングループをリストアップし、取得します。
電子メール購読グループの例を参照したり、このエンドポイントをテストしたい場合：
SMS サブスクリプション・グループの例を参照したり、このエンドポイントをテストしたい場合：
WhatsApp Groups用のエンドポイントの例やテストをご覧になりたい場合は、こちらをクリックしてください：
前提条件
このエンドポイントを使用するには、subscription.groups.get パーミッションを持つAPI キーが必要です。
レート制限
We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.
リクエストパラメータ
| パラメータ｜必須｜データ型｜説明 | |||
|---|---|---|---|
external_id |
必須 | String | ユーザーのexternal_id (最低1つ、最大50external_ids を含む必要がある)。 |
email |
Required* | String | ユーザーのメールアドレス。文字列の配列として渡すことができます。少なくとも1つのEメールアドレスを含むこと（最大50個まで）。 |
phone ｜必須*｜E.164形式の文字列｜ユーザーの電話番号。少なくとも1つの電話番号を含むこと（最大50）。 |
|||
limit ｜オプション｜整数｜返される結果の最大数の制限。デフォルト（最大）limit は100。 |
|||
offset ｜任意｜整数｜検索条件に合う残りのテンプレートを返す前にスキップするテンプレートの数。 |
tip:
同じメールアドレスを共有する複数のユーザー（複数のexternal_ids ）が存在する場合、すべてのユーザーは別々のユーザーとして返されます（同じメールアドレスまたは購読グループを持っていても）。
リクエスト例
https://rest.iad-03.braze.com/subscription/user/status?external_id[]=1&external_id[]=2
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=example@braze.com&limit=100&offset=0' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」