ユーザー設定センターの URL の生成
get
/preference_center/v1/{preferenceCenterExternalID}/url/{userID}
このエンドポイントを使用して、ユーザー設定センターの URL を生成します。
ユーザー設定センター URL はユーザーごとに一意です。
前提条件
このエンドポイントを使用するには、API キーとpreference_center.user.get
の権限が必要です。
レート制限
このエンドポイントには、1 分あたり、ワークスペース あたり、レート制限 1,000 のリクエストがあります。
パスパラメーター
パラメータ | 必須 | データ型 | 説明 |
---|---|---|---|
preferenceCenterExternalID |
必須 | 文字列 | ユーザー設定センターの ID。 |
userID |
必須 | 文字列 | ユーザー ID。 |
リクエストパラメーター
パラメータ | 必須 | データ型 | 説明 |
---|---|---|---|
preference_center_api_id |
必須 | 文字列 | ユーザー設定センターの ID。 |
external_id |
必須 | 文字列 | ユーザーの外部ID。 |
例のリクエスト
1
2
curl --location --request GET 'https://rest.iad-01.braze.com/preference_center/v1/$preference_center_external_id/url/$user_external_id' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE'
応答
1
2
3
{
"preference_center_url": "https://www.example.com/preferences"
}
note:
このエンドポイントは、新しいユーザー設定センター (API またはドラッグアンドドロップエディタを使用して作成されたユーザー設定センターなど) のURL のみを生成します。
New Stuff!