Skip to content

ユーザー設定センターを作成

post

/preference_center/v1

このエンドポイントを使用してプリファレンスセンターを作成し、ユーザーがメールキャンペーンの通知設定を管理できるようにします。API で生成されたプリファレンスセンターを構築する手順については、「API によるプリファレンスセンターの作成」を参照してください。

See me in Postman

前提条件

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

レート制限

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

リクエスト本文

1
2

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

1
2
3
4
5
6
7
8
9
10

{
  "name": "string",
  "preference_center_title": "string",
  "preference_center_page_html": "string",
  "confirmation_page_html": "string",
  "state": (optional) Choose `active` or `draft`. Defaults to `active` if not specified,
  "options": {
    "meta-viewport-content": "string", (optional) Only the `content` value of the meta tag
  }
}

リクエストパラメーター

パラメーター 必須 データ型 説明
name 必須 文字列 以下の要件を満たすプリファレンスセンターの名前:
-文字、数字、ハイフン、アンダースコアのみを含む
-スペースなし
preference_center_title オプション 文字列 プリファレンスセンターと確認ページのタイトル。タイトルが指定されていない場合、ページのタイトルはデフォルトで「プリファレンスセンター」になります。
preference_center_page_html 必須 文字列 プリファレンスセンターページのHTML。
confirmation_page_html 必須 文字列 確認ページのHTML。
state オプション 文字列 active またはを選択してくださいdraft。active指定しない場合はデフォルトです。
options オプション オブジェクト 属性:meta-viewport-content.存在する場合、viewportcontent= <value of attribute>メタタグがでページに追加されます。

液体タグ

プリファレンスセンターページでユーザーのサブスクリプション状態を生成するには、HTMLに含めることができる以下のLiquidタグを参照してください。

ユーザーサブスクリプションの状態

リキッド 説明
{{subscribed_state.${email_global}}} ユーザーのグローバルな電子メール購読状態（「opted_in」、「購読済み」、「購読解除」など）を取得する。
{{subscribed_state.${<subscription_group_id>}}} ユーザーの指定されたサブスクリプショングループのサブスクライブ状態（「サブスクライブ済み」や「サブスクライブ解除」など）を取得する。

フォーム入力とアクション

リキッド 説明
{% form_field_name :email_global_state %} 特定のフォーム入力要素がユーザーのグローバル電子メール購読状態に対応することを示します。グローバル電子メール購読状態の選択データとともにフォームが送信される場合、ユーザーの選択状態は「opted_in」、「subscribed」、または「unsubscribed」である必要があります。チェックボックスの場合、ユーザーは「opted_in」または「unsubscribe」になります。非表示の入力の場合、「サブスクライブ済み」状態も有効です。
{% form_field_name :subscription_group <subscription_group_id> %} 特定のフォーム入力要素が特定のサブスクリプショングループに対応することを示します。特定の購読グループの選択データを含むフォームを送信する場合、ユーザーの選択状態は「購読済み」または「購読解除」のいずれかでなければなりません。
{{preference_center_submit_url}} フォーム送信用のURLを生成します。

レスポンス例

1
2
3
4
5
6

{
  "preference_center_api_id": "preference_center_api_id_example",
  "liquid_tag": "{{preference_center.${MyPreferenceCenter2022-09-22}}}",
  "created_at": "2022-09-22T18:28:07+00:00",
  "message": "success"
}
  Edit this page on GitHub
HOW HELPFUL WAS THIS PAGE?
New Stuff!