Skip to content

ユーザー設定センターの詳細を表示する

get

/preference_center/v1/{preferenceCenterExternalID}

このエンドポイントを使用して、ユーザー設定センターの詳細 (作成日時や更新日時など) を表示します。

前提条件

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

レート制限

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

パスパラメーター

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

リクエストパラメーター

このエンドポイントのリクエストパラメータはありません。

例のリクエスト

1
2
curl --location -g --request GET https://rest.iad-01.braze.com/preference_center/v1/preference_center_external_id \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

応答

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "name": "My Preference Center",
  "preference_center_api_id": "preference_center_api_id",
  "created_at": "example_time_created",
  "updated_at": "example_time_updated",
  "preference_center_title": "Example preference center title",
  "preference_center_page_html": "HTML for preference center here",
  "confirmation_page_html": "HTML for confirmation page here",
  "redirect_page_html": null,
  "preference_center_options": {
    "meta-viewport-content": "width=device-width, initial-scale=2"
  },
  "state": "active"
}
「このページはどの程度役に立ちましたか?」
New Stuff!