Skip to content

ユーザー設定センターを更新

put

/preference_center/v1/{preferenceCenterExternalID}

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

See me in Postman

前提条件

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

レート制限

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

パスパラメータ

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

Request body

1
2

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

1
2
3
4
5
6
7
8
9

{
  "name": "preference_center_name",
  "preference_center_title": "string",
  "preference_center_page_html": "string",
  "confirmation_page_html": "string",
  "options": {
    "meta-viewport-content": "string", (optional) Only the `content` value of the meta tag
  }
}

リクエストパラメーター

パラメータ required データ型 説明
preference_center_page_html 必須 string ユーザー設定センターページのHTML。
preference_center_title オプション string ユーザー設定センターと確認ページのタイトル。タイトルが指定されていない場合、ページのタイトルはデフォルトで「ユーザー設定センター」になります。
confirmation_page_html 必須 string 確認ページのHTML。
state オプション string active または draft を選択してください。
options オプション オブジェクト 属性: meta-viewport-content.存在する場合、viewportメタタグがcontent= <value of attribute>と共にページに追加されます。

例のリクエスト

1
2
3
4
5
6
7
8
9
10
11

curl --location --request POST 'https://rest.iad-01.braze.com/preference_center/v1/{preferenceCenterExternalId}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE' \
--data-raw '{
  "name": "Example",
  "preference_center_title": "Example Preference Center Title",
  "preference_center_page_html": "HTML for preference center here",
  "confirmation_page_html": "HTML here with a message to users here",
  "state": "active"
}
'

応答の例

1
2
3
4
5
6

{
  "preference_center_api_id": "8efc52aa-935e-42b7-bd6b-98f43bb9b0f1",
  "created_at": "2022-09-22T18:28:07Z",
  "updated_at": "2022-09-22T18:32:07Z",
  "message": "success"
}
Github   GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!