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

put

/preference_center/v1/{preferenceCenterExternalID}

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

See me in Postman

前提条件

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

レート制限

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

パスパラメーター

パラメータ required データ型説明

preferenceCenterExternalID 必須文字列ユーザー設定センターの ID。

要求本文:

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

{
  "name": "preference_center_name",
  "preference_center_title": "string",
  "preference_center_page_html": "string",
  "confirmation_page_html": "string",
  "options": {
    "unknown macro": {links-tags}
  "options": {
    "meta-viewport-content": "string", (optional) Only the `content` value of the meta tag,
    "links-tags": [
      {
        "rel": "string", (required) One of: "icon", "shortcut icon", or "apple-touch-icon",
        "type": "string", (optional) Valid values: "image/png", "image/svg", "image/gif", "image/x-icon", "image/svg+xml", "mask-icon",
        "sizes": "string", (optional),
        "color": "string", (optional) Use when type="mask-icon",
        "href": "string", (required)
      }
    ]
  }
} 

リクエストパラメーター

パラメーター required データ型説明

preference_center_page_html 必須文字列ユーザー設定センター画面のHTMLです。

preference_center_title オプション文字列ユーザー設定センターおよび確定ページのタイトル。タイトルが指定されていない場合、ページのタイトルはデフォルトで「ユーザー設定センター」になります。

confirmation_page_html 必須文字列確定画面のHTML。

state オプション文字列 active またはdraft を選択する。

options オプションオブジェクト属性:
meta-viewport-content:存在する場合、viewport メタタグがcontent= <value of attribute> でページに追加されます。

link-tags:ページのファビコンを設定します。設定すると、rel 属性を持つ<link> タグがページに追加されます。

例のリクエスト

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"
}
'

応答の例

{
  "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!