Skip to content

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

get

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

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

ユーザー設定センター URL はユーザーごとに一意です。

前提条件

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

レート制限

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

パスパラメータ

パラメータ required データ型 説明
preferenceCenterExternalID 必須 string ユーザー設定センターの ID。
userID 必須 string ユーザー ID。

リクエストパラメーター

パラメータ required データ型 説明
preference_center_api_id 必須 string ユーザー設定センターの ID。
external_id 必須 string ユーザーの外部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!