Skip to content

Stores the lock screen configuration a space shows to non-members.

The route group only requires portal access, so the controller performs its own check and returns 403 unless the caller manages spaces or holds the admin role in this one.

Endpoint

  • Method: PUT

  • Path: /spaces/{spaceSlug}/lockscreens

  • Edition: PRO

  • Controller: ProAdminController@updateSpaceLockscreenSettings

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

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

  • Requires community-admin or course-admin access, or the admin role in this space.

  • 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 Space Lockscreen Settings

PUT
/spaces/{spaceSlug}/lockscreens

Stores the lock screen configuration a space shows to non-members.

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

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Parameters

Path Parameters

spaceSlug*

SpaceSlug extracted from the URL path.

Type
string
Required

Request Body

application/json
JSON
{
  
"lockscreen": [
  
  
"string"
  
]
}

Responses

Successful response

application/json
JSON
{
  
"community": {
  
  
"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",
  
  
  
"custom_lock_screen": "string",
  
  
  
"default_comment_sort_by": "string",
  
  
  
"default_post_sort_by": "string",
  
  
  
"disable_layout_style": "string",
  
  
  
"disable_post_sort_by": "string",
  
  
  
"document_access": "string",
  
  
  
"document_library": "string",
  
  
  
"document_upload": "string",
  
  
  
"emoji": "string",
  
  
  
"hide_members_count": "string",
  
  
  
"layout_style": "string",
  
  
  
"links": [
  
  
  
  
{
  
  
  
  
  
"slug": "string",
  
  
  
  
  
"title": "string"
  
  
  
  
}
  
  
  
],
  
  
  
"media_access": "string",
  
  
  
"media_gallery": "string",
  
  
  
"members_page_status": "string",
  
  
  
"og_image": "string",
  
  
  
"onboard_redirect_url": "string",
  
  
  
"restricted_post_only": "string",
  
  
  
"shape_svg": "string",
  
  
  
"show_paywalls": "string",
  
  
  
"show_sidebar": "string",
  
  
  
"topic_required": "string"
  
  
},
  
  
"slug": "string",
  
  
"status": "string",
  
  
"title": "string",
  
  
"type": "string",
  
  
"updated_at": "string"
  
},
  
"message": "string"
}

Playground

Authorization
Variables
Key
Value
Body

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation