Skip to main content
イベント更新
PATCH

Authorizations

Authorization
string
header
required

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

Path Parameters

project_id
string
required

イベントID

Body

application/json

指定した項目だけを更新します。取得応答の値をそのまま送り返した項目(値が変わらない項目)は検証されません

name
string

イベント名

Maximum string length: 255
system_name
string | null

管理名称。null でクリア

Maximum string length: 255
event_group_id
string | null

イベントグループ(画面の「グループ」)のID。null で未分類に変更

fee_type
string

参加費。free(無料)/ paid(有料)。古いイベントの paid_limited は現在の値と同じ場合だけ送り返せます(現在の値と同じ値は検証しません)

fee
integer | null

参加費の金額(円)。更新後の参加費が有料のときは必須

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

決済種別。stripe / univapay(Univapay)/ telecom(テレコムクレジット)/ firstpayment(FirstPayment)/ aquagates(AQUAGATES。利用できる環境のみ)。更新後の参加費が有料のときは必須。画面で設定した robotpayment(RobotPayment)は現在の値と同じ場合だけ送り返せます(API では新たに指定できません。現在の値と同じ値は検証しません)

payment_setting_id
string | null

決済連携設定のID。null を指定するとデフォルトの決済連携設定に差し替えます(デフォルトが無い場合は変更されません)

business_id
string | null

領収書設定の「事業者」のID。null でデフォルトに戻します

use_limited_price
boolean

期間限定価格を指定するかどうか。false を指定すると期間限定価格はすべて削除されます。false から true に変更するときは limited_prices を併せて指定します

limited_item
enum<string>

期間限定価格の基準日時。変更するときは新しい基準日時の構造で limited_prices を併せて指定します

Available options:
datetime,
reader_date
limited_prices
object[]

期間限定価格の一覧。指定時はすべて置き換えます(期間限定価格を使うときは1件以上。クリアするときは use_limited_price を false にします)

Maximum array length: 100
deadline_day
integer

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

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

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

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

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

Available options:
none,
auto
deadline_to_day
integer

申し込み可能な日程の日数

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

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

Available options:
deny,
allow,
allow_cancel
has_reminder
boolean

リマインダ配信を使うかどうか。false を指定すると reminder_scenario_id はクリアされます。申込方式がLINEのみのイベントでは false にできません

reminder_scenario_id
string | null

連携配信シナリオのID。リマインダ配信を使う状態にするときは必須。他のイベントと連携済み・削除済みのシナリオは指定できません。申込方式がLINEのみのイベントではLIFF連携済みのLINEの配信アカウントのシナリオを指定します

is_test_mode
boolean

決済モード。true はテストモード、false は本番モード

is_archived
boolean

アーカイブ済にするかどうか

type
string

種類。作成後は変更できないため、現在の値だけを送れます(取得応答の送り返し用)

use_line_event
boolean

申込方式。作成後は変更できないため、現在の値だけを送れます(取得応答の送り返し用)

Response

更新後のイベントの詳細

data
object

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