Skip to main content
申込者更新
PATCH

Authorizations

Authorization
string
header
required

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

Path Parameters

project_id
string
required

イベントID

applicant_id
string
required

申込者ID

Body

application/json

申込者の更新項目。指定したフィールドだけを更新します(お名前・メールアドレス・電話番号・住所は更新できません)

status_participation
enum<string>

参加状況(reserved=参加予定、attended=参加済、delay=遅刻、cancel_contact=キャンセル(連絡あり)、cancel_no_contact=キャンセル(連絡なし)、cancel_changed=キャンセル(日程変更済))

Available options:
reserved,
attended,
delay,
cancel_contact,
cancel_no_contact,
cancel_changed
status_contract
enum<string>

成約状況(unregistered=未登録、paid=決済済、scheduled=決済予定、consider=検討中、no_contract=不成約)

Available options:
unregistered,
paid,
scheduled,
consider,
no_contract
memo
string | null

メモ

Maximum string length: 65535
paid_amount
integer | null

入金額。イベントの参加費が「有料」の場合だけ更新され、「無料」のイベントでは無視されます

Required range: 0 <= x <= 99999999
cancel_reason
string | null

キャンセル理由

Maximum string length: 65535
custom_fields
object

申込者項目。キーは event_item01〜event_item20、値は文字列または null(null でクリア)。指定したキーだけを更新します。イベントで使用中でない項目を指定すると 422(details のキーは custom_fields.event_itemNN)

send_cancel_notification
boolean
default:false

参加予定・参加済・遅刻からキャンセル(連絡あり)へ変更するとき、申込者へキャンセルのメール(申込方式が「LINEのみ」のイベントではLINE)を送信するか。イベント設定「キャンセル時の動作設定」の「メール自動返信」(申込方式が「LINEのみ」のイベントでは「LINE自動返信」)が「送信する」の場合だけ送信されます。画面の「キャンセル処理」の「申込者へのメール送信」(「申込者へのLINE送信」)に相当します

has_step_immediately
boolean
default:false

キャンセル時にシナリオ連携(イベント設定「シナリオ連携」)が有効な場合、連携配信シナリオで「登録直後のステップ配信の対象にする」か

has_step_scheduled
boolean
default:false

同じく「登録以降のステップ配信の対象にする」か

has_reminder
boolean
default:false

同じく「リマインダ配信の対象にする」か

Response

更新された申込者

data
object

申込者の詳細