Skip to main content
会員サイト更新
PATCH

Authorizations

Authorization
string
header
required

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

Path Parameters

site_id
string
required

会員サイトID

Body

application/json

会員サイトの更新内容。指定したフィールドだけを更新します

name
string

サイト名

Maximum string length: 255
memo
string | null

メモ(管理画面でのみ表示。最大65,535文字)

Copyright表記(フッター)

Maximum string length: 255
temporary_password
string

アカウント自動発行時仮パスワード(半角英数字と記号 !@#$%^&*()_+-=[]{}|'" のみ)

Maximum string length: 255
Pattern: ^[a-zA-Z0-9!@#$%^&*()_+\-=\[\]{}|'"]+$
days_to_password_change
integer | null

新規ユーザーへのパスワード変更の強制(初めてログインしてから何日後に強制するか。0 は初回ログイン直後)。null を指定すると強制しない設定になり、パスワード変更が未完了の受講生への変更要求も解除されます

Required range: 0 <= x <= 365
js_head
string | null

headタグの最後に挿入するJavaScript(サイト共通)

js_body_top
string | null

bodyタグの最初に挿入するJavaScript(サイト共通)

js_body
string | null

bodyタグの最後に挿入するJavaScript(サイト共通)

login_type
enum<string>

ログインなしでの閲覧。require: 不可(全てのコンテンツでログインが必須)/ optional: 可(指定したコンテンツのみ閲覧可能)/ none: 可(全てのコンテンツが閲覧可能)。コース・レッスンの開放日・締め切りに reader_date を指定できるのは optional / none のときだけです

Available options:
require,
optional,
none
use_bookmark
boolean

ブックマーク機能を利用するか

is_no_index
boolean

検索エンジンへの表示(true は検索エンジンに非表示)

コミュニティへのリンクを表示するか。コミュニティ機能が有効な会員サイトでのみ変更できます(無効なサイトで現在と異なる値を指定すると 400 bad_request)

login_background
string | null

ログインページ全体の背景色(#RRGGBB。null でクリア)

login_background_center
string | null

ログインページ中央枠内の背景色(#RRGGBB。null でクリア)

ログインページでサイトロゴ画像を利用するか

login_logo_url
string | null

ログインページのロゴ画像URL(URL形式。不正な形式は 422)

Maximum string length: 255

ログインページのフッターメニューを利用するか。false を指定すると登録済みのフッターメニュー項目は全て削除されます

ログインページのフッターメニュー項目(指定した内容で全件置き換え)。login_footer_use_menu が false になる場合は指定できません(422)

use_description
boolean

コースページにトップページ説明文を表示するか

description
string | null

トップページ説明文(HTML。最大65,535文字)

use_news
boolean

コースページにお知らせを表示するか

コースページに検索欄を表示するか

show_course_category
boolean

コースページにカテゴリ選択欄を表示するか

search_type
enum<string>

検索する範囲。all: レッスン内容含め全て / course_name: コース名のみ

Available options:
all,
course_name
course_display_type
enum<string>

コースの表示形式。all: すべてのコースを一覧で表示 / group: グループごとにコースを表示 / only_group: グループを選択後コースを表示。コース並び替えのリクエスト形式とコースグループの画像の可否がこの値で変わります

Available options:
all,
group,
only_group
course_name_font_size
string | null

コース名の文字サイズ(16px〜26px の 1px 刻み。null でデフォルト)

course_background
string | null

コースページの背景色(#RRGGBB。null でクリア)

course_header_background
string | null

ヘッダー色(#RRGGBB。null でクリア)

course_header_color
string | null

ヘッダー文字色(#RRGGBB。null でクリア)

ヘッダーにサイトロゴ画像を利用するか

course_header_logo_url
string | null

ヘッダーのロゴ画像URL(URL形式。不正な形式は 422)

Maximum string length: 255
course_header_use_menu
boolean

ヘッダーメニューを利用するか。false を指定すると登録済みのヘッダーメニュー項目は全て削除されます

course_header_menu_items
object[]

ヘッダーメニュー項目(指定した内容で全件置き換え)。course_header_use_menu が false になる場合は指定できません(422)

フッター色(#RRGGBB。null でクリア)

フッター文字色(#RRGGBB。null でクリア)

フッターメニューを利用するか。false を指定すると登録済みのフッターメニュー項目は全て削除されます

フッターメニュー項目(指定した内容で全件置き換え)。course_footer_use_menu が false になる場合は指定できません(422)

lesson_complete_type
enum<string>

完了ボタンを押した後の動作。stay: 何もしない / go_next: 次のレッスンページへ遷移

Available options:
stay,
go_next
lesson_show_all_lessons
boolean

レッスン一覧の表示形式。false: 同一グループのレッスンのみ表示 / true: 全てのレッスンを表示

レッスンページに検索欄を表示するか

Response

更新後の会員サイトの設定

data
object

会員サイト(設定を含む全項目)