Skip to main content
コース作成
POST

Authorizations

Authorization
string
header
required

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

Path Parameters

site_id
string
required

会員サイトID

Body

application/json

コースの作成内容。省略できる項目に null を指定した場合は、省略したときと同じ扱い（既定値）になります

name
string
required

コース名

Maximum string length: 255
system_name
string | null

管理名称（設定すると管理画面の一覧でコース名の代わりに表示）

Maximum string length: 255
type
enum<string> | null
default:normal

種類。normal: 通常コース / url: 指定したURLへリンク（それ以外の値は 400 bad_request）

Available options:
normal,
url
url
string | null

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

Maximum string length: 2048
href_type
enum<string> | null

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

Available options:
blank
image_url
string | null

コース画像URL（URL形式。不正な形式は 422）

Maximum string length: 255
button_text
string | null

ボタンテキスト（省略時は「受講する」と表示）

Maximum string length: 255
is_hide_progress
boolean | null
default:false

進捗率を表示しないか（true は表示しない）

is_video_autoplay_setting
boolean | null
default:true

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

comment_setting_type
enum<string> | null
default:individual

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

Available options:
individual,
enable_all
is_published
boolean | null
default:false

ステータス（true は公開、false は下書き）

category_ids
string[] | null

コースカテゴリID（同じ会員サイトのカテゴリ以外は 422）

require_login
boolean | null
default:true

未ログイン時の閲覧（true は不可、false は可）

show_non_purchaser
boolean | null
default:false

未購入者へのオファー設定「常時表示オファー」を利用するか

url_for_non_purchaser
string | null

常時オファーページURL。show_non_purchaser が true のとき必須（false のときは保存されません）

Maximum string length: 255
use_limited_offer
boolean | null
default:false

期間限定オファーを利用するか

limited_offers
object[] | null

期間限定オファー。use_limited_offer が true のとき 1 件以上必須、false のときは指定できません

has_target_persons
boolean | null
default:false

受講対象者をコース登録日で指定するか。true のときは target_persons_date_from と target_persons_date_to の少なくとも一方が必須

target_persons_date_from
string | null

受講対象者のコース登録日の開始日（Y-m-d）

target_persons_date_to
string | null

受講対象者のコース登録日の終了日（Y-m-d。開始日以降）

course_style
enum<string> | null
default:open_all

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

Available options:
open_all,
one_by_one
release_type
enum<string> | null
default:immediately

開放日（開始日）。immediately: コースへ登録後すぐに開放 / scheduled: コースへ登録後、指定した日数経過後に開放 / scheduled_month: コースへ登録後、指定した月数経過後に開放 / datetime: 指定した日時に開放 / reader_date: アクセス元シナリオの配信基準日時から指定した日数経過後に開放（会員サイトの login_type が optional または none のときのみ。それ以外は 400 bad_request）

Available options:
immediately,
scheduled,
scheduled_month,
datetime,
reader_date
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> | null
default:show

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

Available options:
show,
hide
close_type
enum<string> | null
default:none

締め切り（終了日）。none: 締め切りを設けない / scheduled: コースへ登録後、指定した日数経過後に終了 / datetime: 指定した日時に終了 / reader_date: アクセス元シナリオの配信基準日時から指定した日数経過後に終了（会員サイトの login_type が optional または none のときのみ。それ以外は 400 bad_request）

Available options:
none,
scheduled,
datetime,
reader_date
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> | null
default:close

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

Available options:
close,
release

Response

作成されたコース

data
object

コース（設定を含む全項目）