Stores the lock screen a private course shows to visitors who are not enrolled — its copy, imagery and call to action.

Endpoint

• Method: PUT

• Path: /admin/courses/{course_id}/lockscreens

• Edition: PRO

• Controller: ProAdminController@updateCourseLockscreenSettings

• Route source: fluent-community-pro/app/Http/Routes/api.php:63

• Controller source: fluent-community-pro/app/Http/Controllers/ProAdminController.php

• Requires a course admin for this course, or a WordPress user with manage_options.

• Requires FluentCommunity Pro.

Live sample

The request and response below were recorded against a running FluentCommunity install and then anonymised — member names, emails, avatars and post content are fictional, and long collections are trimmed to a few entries.

PUT Update Course Lockscreen Settings

PUT

/admin/courses/{course_id}/lockscreens

Stores the lock screen a private course shows to visitors who are not enrolled — its copy, imagery and call to action.

Controller: ProAdminController@updateCourseLockscreenSettings
Route source: fluent-community-pro/app/Http/Routes/api.php:63

Authorizations

ApplicationPasswords

WordPress Application Passwords — use Basic auth with username:application_password.

Type

API Key (header: Authorization)

Parameters

Path Parameters

course_id*

Course ID extracted from the URL path.

Type

integer

Required

Request Body

application/json

{

  

"lockscreen": [

  

  

"string"

  

]

}

Responses

Successful response

Content-Type

application/json

{

  

"course": {

  

  

"cover_photo": "string",

  

  

"created_at": "string",

  

  

"created_by": "string",

  

  

"description": "string",

  

  

"id": 0,

  

  

"logo": "string",

  

  

"parent_id": "string",

  

  

"privacy": "string",

  

  

"serial": "string",

  

  

"settings": {

  

  

  

"can_request_join": "string",

  

  

  

"course_details": "string",

  

  

  

"course_layout": "string",

  

  

  

"course_type": "string",

  

  

  

"custom_lock_screen": "string",

  

  

  

"disable_comments": "string",

  

  

  

"emoji": "string",

  

  

  

"hide_instructor_view": "string",

  

  

  

"hide_members_count": "string",

  

  

  

"layout_style": "string",

  

  

  

"links": [

  

  

  

  

{

  

  

  

  

  

"slug": "string",

  

  

  

  

  

"title": "string"

  

  

  

  

}

  

  

  

],

  

  

  

"members_page_status": "string",

  

  

  

"og_image": "string",

  

  

  

"public_lesson_view": "string",

  

  

  

"restricted_post_only": "string",

  

  

  

"sequential_lesson_order": "string",

  

  

  

"shape_svg": "string",

  

  

  

"show_instructor_students_count": "string",

  

  

  

"show_paywalls": "string",

  

  

  

"show_sidebar": "string",

  

  

  

"show_welcome_banner": "string",

  

  

  

"topic_required": "string"

  

  

},

  

  

"slug": "string",

  

  

"status": "string",

  

  

"title": "string",

  

  

"type": "string",

  

  

"updated_at": "string"

  

},

  

"message": "string"

}

PUT

/admin/courses/{course_id}/lockscreens

Playground

Authorization

ApplicationPasswords

Variables

Key

Value

course_id*

Body

Samples

Powered by VitePress OpenAPI