Endpoint
- Method:
POST - Path:
/admin/welcome-banner - Edition: Core
- Controller:
AdminController@updateWelcomeBannerSettings - Route source:
fluent-community/app/Http/Routes/api.php:106 - Controller source:
fluent-community/app/Http/Controllers/AdminController.php
POST Save Admin Welcome Banner
POST
/admin/welcome-banner
Save Admin Welcome Banner for the FluentCommunity Admin API.
Controller: AdminController@updateWelcomeBannerSettings
Route source: fluent-community/app/Http/Routes/api.php:106
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": { "enabled": "string", "mediaType": "string", "bannerImage": "string", "bannerVideo": { "type": "string", "url": "string", "content_type": "string", "provider": "string", "title": "string", "author_name": "string", "html": "string" }, "ctaButtons": [ { "label": "string", "link": "string", "type": "string", "newTab": "string" } ], "description": "string", "description_rendered": "string", "allowClose": "string" }, "logout": { "enabled": "string", "mediaType": "string", "bannerImage": "string", "bannerVideo": { "type": "string", "url": "string", "content_type": "string", "provider": "string", "title": "string", "author_name": "string", "html": "string" }, "ctaButtons": [ { "label": "string", "link": "string", "type": "string", "newTab": "string" } ], "description": "string", "description_rendered": "string", "useCustomUrl": "string" } }
{
}