Skip to content

Stores both welcome banner variants and pre-renders their Markdown descriptions to HTML so the portal does not have to parse them per request.

Rendering happens only for a variant whose enabled flag is yes. When the logged-out variant has a button label and useCustomUrl is not yes, its link is replaced with the portal auth URL. The result is written to the options table and cached for a week.

Endpoint

  • Method: POST

  • Path: /admin/welcome-banner

  • Edition: Core

  • Controller: AdminController@updateWelcomeBannerSettings

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

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

  • Requires the FluentCommunity community-admin permission (or a WordPress super admin).

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 Save Admin Welcome Banner

POST
/admin/welcome-banner

Stores both welcome banner variants and pre-renders their Markdown descriptions to HTML so the portal does not have to parse them per request.

Controller: AdminController@updateWelcomeBannerSettings
Route source: fluent-community/app/Http/Routes/api.php:110

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Request Body

application/json
JSON
{
  
"settings": {
  
  
"login": {
  
  
  
"enabled": "string",
  
  
  
"description": "string"
  
  
},
  
  
"logout": {
  
  
  
"enabled": "string",
  
  
  
"description": "string",
  
  
  
"buttonLabel": "string",
  
  
  
"useCustomUrl": "string"
  
  
},
  
  
"$type": [
  
  
  
"string"
  
  
]
  
}
}

Responses

Successful response

application/json
JSON
{
  
"message": "string",
  
"settings": {
  
  
"login": {
  
  
  
"allowClose": "string",
  
  
  
"bannerImage": "string",
  
  
  
"bannerVideo": {
  
  
  
  
"author_name": "string",
  
  
  
  
"content_type": "string",
  
  
  
  
"html": "string",
  
  
  
  
"provider": "string",
  
  
  
  
"title": "string",
  
  
  
  
"type": "string",
  
  
  
  
"url": "string"
  
  
  
},
  
  
  
"ctaButtons": [
  
  
  
  
{
  
  
  
  
  
"label": "string",
  
  
  
  
  
"link": "string",
  
  
  
  
  
"newTab": "string",
  
  
  
  
  
"type": "string"
  
  
  
  
}
  
  
  
],
  
  
  
"description": "string",
  
  
  
"description_rendered": "string",
  
  
  
"enabled": "string",
  
  
  
"mediaType": "string",
  
  
  
"title": "string"
  
  
},
  
  
"logout": {
  
  
  
"bannerImage": "string",
  
  
  
"bannerVideo": {
  
  
  
  
"author_name": "string",
  
  
  
  
"content_type": "string",
  
  
  
  
"html": "string",
  
  
  
  
"provider": "string",
  
  
  
  
"title": "string",
  
  
  
  
"type": "string",
  
  
  
  
"url": "string"
  
  
  
},
  
  
  
"ctaButtons": [
  
  
  
  
{
  
  
  
  
  
"label": "string",
  
  
  
  
  
"link": "string",
  
  
  
  
  
"newTab": "string",
  
  
  
  
  
"type": "string"
  
  
  
  
}
  
  
  
],
  
  
  
"description": "string",
  
  
  
"description_rendered": "string",
  
  
  
"enabled": "string",
  
  
  
"mediaType": "string",
  
  
  
"title": "string"
  
  
}
  
}
}

Playground

Authorization
Body

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation