Skip to main content
イベント作成
POST

Authorizations

Authorization
string
header
required

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

Body

application/json
type
enum<string>
required

種類。seminar(セミナー・説明会)/ calendar(個別相談・個別予約)。作成後は変更できません

Available options:
seminar,
calendar
Example:

"seminar"

name
string
required

イベント名

Maximum string length: 255
system_name
string | null

管理名称

Maximum string length: 255
event_group_id
string | null

イベントグループ(画面の「グループ」)のID。省略・null は未分類

fee_type
enum<string>
default:free

参加費。free(無料)/ paid(有料)

Available options:
free,
paid
fee
integer | null

参加費の金額(円)。fee_type が paid のときは必須

Required range: 1 <= x <= 9999999
payment_method
enum<string> | null

決済種別。stripe / univapay(Univapay)/ telecom(テレコムクレジット)/ firstpayment(FirstPayment)/ aquagates(AQUAGATES。利用できる環境のみ)。fee_type が paid のときは必須。画面で設定できる robotpayment(RobotPayment)は API では指定できません

Available options:
stripe,
univapay,
telecom,
firstpayment,
aquagates
payment_setting_id
string | null

決済連携設定のID。省略時はデフォルトの決済連携設定を使います(デフォルトが無い場合は未設定のまま作成されます。有料イベントでは明示的に指定してください)

business_id
string | null

領収書設定の「事業者」のID。省略・null はデフォルト

use_limited_price
boolean
default:false

期間限定価格を指定するかどうか。true のときは limited_prices が必須

limited_item
enum<string>
default:datetime

期間限定価格の基準日時。datetime(指定日時)/ reader_date(アクセス元シナリオの配信基準日時)

Available options:
datetime,
reader_date
limited_prices
object[]

期間限定価格の一覧(use_limited_price が true のときは必須。limited_item に応じた構造)

Required array length: 1 - 100 elements
deadline_day
integer
default:1

申し込み締切(開催の何日前か)

Required range: -10 <= x <= 10
deadline_hour
integer
default:14

申し込み締切(deadline_day 日前の何時か)

Required range: 0 <= x <= 23
deadline_to_type
enum<string>
default:none

申し込み可能な日程。none(締切前の全ての日程)/ auto(指定した日数分のみ)

Available options:
none,
auto
deadline_to_day
integer
default:0

申し込み可能な日程の日数(deadline_to_type が auto のときに使用)

Required range: 0 <= x <= 32767
multiple_registration_type
enum<string>
default:deny

重複申込。deny(禁止する)/ allow(許可する)/ allow_cancel(許可する。連絡ありでキャンセル済の場合のみ)

Available options:
deny,
allow,
allow_cancel
has_reminder
boolean
default:false

リマインダ配信を使うかどうか。use_line_event が true のときは true が必須

message_account_id
string

連携配信アカウントのID。has_reminder が true のときは必須。use_line_event が true のときはLIFF連携済みのLINEの配信アカウントを指定します

from_name
string

リマインダ送信者名。has_reminder が true で use_line_event が false のときは必須

Maximum string length: 255
from_mail
string

リマインダ送信者メールアドレス(メールアドレス形式。ドメインの DNS レコードも確認します)。has_reminder が true で use_line_event が false のときは必須。GmailやYahoo!メールなどのフリーメール、携帯キャリアメールのアドレスは指定できません

Maximum string length: 255
use_line_event
boolean
default:false

申込方式。true はLINEのみ、false は制限なし。作成後は変更できません

Response

作成されたイベント

data
object

イベントの詳細(画面の「イベント設定」の基本設定・リマインダ設定)