Skip to content

環境設定センターURL の生成

get

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

このエンドポイントを使用して、プリファレンスセンターのURL を生成します。

各プリファレンスセンターのURL は、ユーザーごとに一意です。

前提条件

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

レート制限

このエンドポイントには、ワークスペースあたり1 分あたり1000 件のリクエストのレート制限があります。

パスパラメータ

パラメータ 必須 データ型 説明
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"
}
「このページはどの程度役に立ちましたか?」
New Stuff!