Skip to main content
受講生更新
PATCH

Authorizations

Authorization
string
header
required

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

Path Parameters

site_id
string
required

会員サイトID

student_id
string
required

受講生ID

Body

application/json
name
string | null

名前(null でクリア)

Maximum string length: 255
mail
string

メールアドレス(受講生画面のログインに使用。同じサイト内で重複不可)

Maximum string length: 255
is_suspended
boolean

ステータス(true: 利用停止(ログイン不可)/ false: 利用可)

keep_posts_visible
boolean

コミュニティへの投稿・返信・ダイレクトメッセージを他のユーザーに表示するか(false で非表示)

Response

更新後の受講生

data
object

受講生