Skip to main content
読者作成
curl --request POST \
  --url https://api.utage-system.com/v1/accounts/{account_id}/scenarios/{scenario_id}/readers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "opt_in_confirmed": true,
  "scenario_fields": {},
  "common_fields": {},
  "has_step_immediately": true,
  "has_step_scheduled": true,
  "has_reminder": true,
  "allow_duplicates": true
}
'
{
  "data": {
    "id": "<string>",
    "common_reader_id": "<string>",
    "scenario_id": "<string>",
    "ip": "<string>",
    "line_display_name": "<string>",
    "line_picture_url": "<string>",
    "line_friend_id": "<string>",
    "base_date": "<string>",
    "is_blocked": true,
    "is_line_blocked": true,
    "is_mail_error": true,
    "is_sms_blocked": true,
    "block_datetime": "<string>",
    "partner": {
      "project_name": "<string>",
      "name": "<string>",
      "reward": 123
    },
    "has_step_scheduled": true,
    "has_reminder": true,
    "message_tracking_id": "<string>",
    "message_tracking_name": "<string>",
    "funnel_tracking_id": "<string>",
    "funnel_tracking_name": "<string>",
    "referrer": "<string>",
    "labels": [
      {
        "id": "<string>",
        "name": "<string>",
        "assigned_at": "<string>"
      }
    ],
    "scenario_fields": {},
    "common_fields": {},
    "memo": "<string>",
    "created_at": "<string>"
  }
}
POST
https://api.utage-system.com/v1/accounts/{account_id}/scenarios/{scenario_id}/readers
この機能はプレビュー版です。仕様が変更される場合があります。

Authorizations

Authorization
string
header
required

APIキーをBearerトークンとして指定

Path Parameters

account_id
string
required

アカウントID

scenario_id
string
required

シナリオID

Body

application/json
opt_in_confirmed
boolean
required

オプトイン取得済みの確認(true のみ受付・必須)。オプトインを取得済みのアドレスのみ登録すること

scenario_fields
object

シナリオ固有の読者項目(キー=項目名、値=文字列)。メールアドレスはここに指定(scenario_fields.mail)。 mail はメール/メール・LINE併用アカウントでは必須で、RFC・DNS検証あり(最大255文字)。

common_fields
object

全シナリオ共通の読者項目(キー=項目名、値=文字列)

has_step_immediately
boolean

登録直後のステップ配信の対象にする(デフォルトfalse。作成時のみ指定可能)

has_step_scheduled
boolean

ステップ配信の対象にする(デフォルトfalse)

has_reminder
boolean

リマインダ配信の対象にする(デフォルトfalse)

allow_duplicates
boolean

重複登録を許可する(デフォルトfalse)。falseのとき、同一シナリオ内に配信解除されていない同一メールアドレスの読者が既に存在すると422になります

Response

作成された読者

data
object

読者の詳細情報。読者項目はトップレベルではなく scenario_fields(シナリオ固有)/ common_fields(全シナリオ共通)の2グループで返る。トップレベルはシステム情報のみ。