Skip to content

環境設定センターの詳細を表示する

get

/preference_center/v1/{preferenceCenterExternalID}

このエンドポイントを使用して、いつ作成および更新されたかを含め、プリファレンスセンターの詳細を表示します。

See me in Postman

前提条件

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

レート制限

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

パスパラメータ

パラメータ 必須 データ型 説明
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"
}
  Edit this page on GitHub
HOW HELPFUL WAS THIS PAGE?
New Stuff!