Returns the two course welcome banner variants, one for enrolled students and one for visitors who have not enrolled.

Endpoint

• Method: GET

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

• Edition: PRO

• Controller: ProAdminController@getCourseWelcomeBannerSettings

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

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

GET Get Course Welcome Banner Settings

GET

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

Returns the two course welcome banner variants, one for enrolled students and one for visitors who have not enrolled.

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

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

Responses

Successful response

Content-Type

application/json

{

  

"settings": {

  

  

"enrolled": {

  

  

  

"allowClose": "string",

  

  

  

"bannerImage": "string",

  

  

  

"bannerVideo": {

  

  

  

  

"author_name": "string",

  

  

  

  

"content_type": "string",

  

  

  

  

"html": "string",

  

  

  

  

"provider": "string",

  

  

  

  

"title": "string",

  

  

  

  

"type": "string",

  

  

  

  

"url": "string"

  

  

  

},

  

  

  

"ctaButtons": [

  

  

  

  

{

  

  

  

  

  

"additionalProperties": "string"

  

  

  

  

}

  

  

  

],

  

  

  

"description": "string",

  

  

  

"enabled": "string",

  

  

  

"mediaType": "string",

  

  

  

"title": "string"

  

  

},

  

  

"not_enrolled": {

  

  

  

"allowClose": "string",

  

  

  

"bannerImage": "string",

  

  

  

"bannerVideo": {

  

  

  

  

"author_name": "string",

  

  

  

  

"content_type": "string",

  

  

  

  

"html": "string",

  

  

  

  

"provider": "string",

  

  

  

  

"title": "string",

  

  

  

  

"type": "string",

  

  

  

  

"url": "string"

  

  

  

},

  

  

  

"ctaButtons": [

  

  

  

  

{

  

  

  

  

  

"additionalProperties": "string"

  

  

  

  

}

  

  

  

],

  

  

  

"description": "string",

  

  

  

"enabled": "string",

  

  

  

"mediaType": "string",

  

  

  

"title": "string"

  

  

}

  

}

}

GET

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

Playground

Authorization

ApplicationPasswords

Variables

Key

Value

course_id*

Samples

Powered by VitePress OpenAPI