Skip to content

ユーザー設定センターのURLの生成

get

/preference_center/v1/{preferenceCenterExternalID}/url/{userID}

このエンドポイントを使用して、ユーザー設定センターのURLを生成します。

ユーザー設定センターのURLはユーザーごとにユニークです。

See me in Postman

前提条件

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

レート制限

このエンドポイントには、APIレート制限に記載されているように、1ワークスペースあたり1分あたり1,000リクエストのレート制限があります。

このレート制限は固定であり、変更できません。

パスパラメーター

パラメーター 必須 データタイプ 説明
preferenceCenterExternalID 必須 文字列 ユーザー設定センターのID。
userID 必須 文字列 ユーザーID。

リクエストパラメーター

パラメーター 必須 データタイプ 説明
preference_center_api_id 必須 文字列 ユーザー設定センターのID。
external_id 必須 文字列 ユーザーのexternal 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"
}
New Stuff!