Skip to main content
コース更新
PATCH

Authorizations

Authorization
string
header
required

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

Path Parameters

site_id
string
required

会員サイトID

course_id
string
required

コースID

Body

application/json

コースの更新内容。指定したフィールドだけを更新します。type / href_type / release_type / close_type は、現在の値と同じ値であれば取得応答の値(過去に設定された値を含む)をそのまま送り返せます。limited_offers は全件置き換えのため常に検証され、過去の起算日時(bundle_enrolled_date_addition / reader_date_addition)の要素や、参照先のバンドルが削除されて bundle_id が null の要素は、直すか除かないと 422 になります

name
string

コース名

Maximum string length: 255
system_name
string | null

管理名称(null でクリア)

Maximum string length: 255
type
string

種類。新しく指定できるのは normal: 通常コース / url: 指定したURLへリンク(それ以外への変更は 400 bad_request)

url
string | null

リンク先URL。更新後の type が url のとき必須

Maximum string length: 2048
href_type
string | null

リンクの開き方(type が url のとき)。null: 通常 / blank: 別ウィンドウ

image_url
string | null

コース画像URL(URL形式。不正な形式は 422。null でクリア)

Maximum string length: 255
button_text
string | null

ボタンテキスト(null にすると「受講する」と表示)

Maximum string length: 255
is_hide_progress
boolean

進捗率を表示しないか(true は表示しない)

is_video_autoplay_setting
boolean

動画自動再生/視聴完了設定を表示するか

comment_setting_type
enum<string>

コメント機能。individual: 各レッスンごとに設定 / enable_all: 全レッスンで利用する

Available options:
individual,
enable_all
is_published
boolean

ステータス(true は公開、false は下書き)

category_ids
string[]

コースカテゴリID(指定した内容で全件置き換え。空配列で全て解除。同じ会員サイトのカテゴリ以外は 422)

require_login
boolean

未ログイン時の閲覧(true は不可、false は可)

show_non_purchaser
boolean

未購入者へのオファー設定「常時表示オファー」を利用するか。更新後に false の場合、url_for_non_purchaser は null になります

url_for_non_purchaser
string | null

常時オファーページURL。更新後の show_non_purchaser が true のとき必須

Maximum string length: 255
use_limited_offer
boolean

期間限定オファーを利用するか。false を指定すると登録済みの期間限定オファーは全て削除されます

limited_offers
object[]

期間限定オファー(指定した内容で全件置き換え。要素は常に検証されるため、取得応答の要素のうち過去の起算日時の要素や bundle_id が null の要素は直すか除いてください)。更新後の use_limited_offer が true のとき 1 件以上必須、false のときは指定できません

has_target_persons
boolean

受講対象者をコース登録日で指定するか。更新後に true の場合は target_persons_date_from と target_persons_date_to の少なくとも一方が必要

target_persons_date_from
string | null

受講対象者のコース登録日の開始日(Y-m-d。null でクリア)

target_persons_date_to
string | null

受講対象者のコース登録日の終了日(Y-m-d。開始日以降。null でクリア)

course_style
enum<string>

受講スタイル。open_all: 最初から開放済みの全てのレッスンが受講可能 / one_by_one: 受講完了に変更すると次のレッスンが受講可能

Available options:
open_all,
one_by_one
release_type
string

開放日(開始日)。新しく指定できるのは immediately / scheduled / scheduled_month / datetime / reader_date(意味はコース作成と同じ)。reader_date への変更は会員サイトの login_type が optional または none のときのみ(それ以外は 400 bad_request)

release_day
integer | null

開放日数。更新後の release_type が scheduled / reader_date のとき必須

Required range: 0 <= x <= 9999
release_month
integer | null

開放月数。更新後の release_type が scheduled_month のとき必須

Required range: 0 <= x <= 9999
release_date
string | null

開放日(Y-m-d)。更新後の release_type が datetime のとき必須

release_hour
integer | null

開放時刻(0〜23)。更新後の release_type が immediately 以外のとき必須

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

開放前の表示。show: 表示する / hide: 表示しない

Available options:
show,
hide
close_type
string

締め切り(終了日)。新しく指定できるのは none / scheduled / datetime / reader_date(意味はコース作成と同じ)。reader_date への変更は会員サイトの login_type が optional または none のときのみ(それ以外は 400 bad_request)

close_day
integer | null

締め切り日数。更新後の close_type が scheduled / reader_date のとき必須

Required range: 0 <= x <= 9999
close_date
string | null

締め切り日(Y-m-d)。更新後の close_type が datetime のとき必須

close_hour
integer | null

締め切り時刻(0〜23)。更新後の close_type が none 以外のとき必須

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

受講停止時の動作。close: 全て閲覧不可 / release: 停止日までに開放済みのレッスンは引き続き閲覧可

Available options:
close,
release

Response

更新後のコースの設定

data
object

コース(設定を含む全項目)