読者作成
プレビュー機能。仕様は今後変更される可能性があります。 指定シナリオに読者を1件登録します。オプトインを取得済みのアドレスのみ登録してください。
読者項目は scenario_fields(シナリオ固有。メールアドレスは scenario_fields.mail に指定)と common_fields(全シナリオ共通)の2グループで指定します。
メール/メール・LINE併用アカウントでは mail が必須です。各グループのキーは項目名(置き換え文字名)で、置き換え文字一覧の field_group で各項目がどちらのグループかを確認できます。
このエンドポイントはバーストが発生するため分間レート制限(60回/分)の対象外で、独自の時間/月間上限で制御されます。
POST
Authorizations
APIキーをBearerトークンとして指定
Body
オプトイン取得済みの確認(true のみ受付・必須)。オプトインを取得済みのアドレスのみ登録すること
シナリオ固有の読者項目(キー=項目名、値=文字列)。メールアドレスはここに指定(scenario_fields.mail)。
mail はメール/メール・LINE併用アカウントでは必須で、RFC・DNS検証あり(最大255文字)。
全シナリオ共通の読者項目(キー=項目名、値=文字列)
登録直後のステップ配信の対象にする(デフォルトfalse。作成時のみ指定可能)
ステップ配信の対象にする(デフォルトfalse)
リマインダ配信の対象にする(デフォルトfalse)
重複登録を許可する(デフォルトfalse)。falseのとき、同一シナリオ内に配信解除されていない同一メールアドレスの読者が既に存在すると422になります
Response
作成された読者
読者の詳細情報。読者項目はトップレベルではなく scenario_fields(シナリオ固有)/ common_fields(全シナリオ共通)の2グループで返る。トップレベルはシステム情報のみ。