Skip to content

Stores both course welcome banner variants and pre-renders their Markdown descriptions to HTML.

Only the enrolled and not_enrolled views are recognised. The banner is displayed only while the course show_welcome_banner setting is on, which is saved through the course update endpoint rather than here.

Endpoint

  • Method: POST

  • Path: /admin/courses/{course_id}/welcome-banner

  • Edition: PRO

  • Controller: ProAdminController@updateCourseWelcomeBannerSettings

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

  • 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.

POST Post Update Course Welcome Banner Settings

POST
/admin/courses/{course_id}/welcome-banner

Stores both course welcome banner variants and pre-renders their Markdown descriptions to HTML.

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

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
JSON
{
  
"settings": {
  
  
"$view ": {
  
  
  
" '": {
  
  
  
  
"description'": "string"
  
  
  
}
  
  
},
  
  
"$type": [
  
  
  
"string"
  
  
]
  
}
}

Responses

Successful response

application/json
JSON
{
  
"message": "string",
  
"settings": [
  
  
{
  
  
  
"additionalProperties": "string"
  
  
}
  
]
}

Playground

Authorization
Variables
Key
Value
Body

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation