Skip to content

Persists the portal-wide settings record — branding, access level, auth copy and redirects, and the portal slug.

Only keys that already exist in the stored settings are accepted, so unknown fields are dropped silently. Logo, white-logo and featured-image URLs are resolved against the media table and the matching media rows are marked active so the cleanup cron does not remove them. Changing slug flushes the rewrite rules and returns a redirect_url; the slug is ignored when the FLUENT_COMMUNITY_PORTAL_SLUG constant is defined.

Endpoint

  • Method: POST

  • Path: /admin/general

  • Edition: Core

  • Controller: AdminController@saveGeneralSettings

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

  • 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 General Settings

POST
/admin/general

Persists the portal-wide settings record — branding, access level, auth copy and redirects, and the portal slug.

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

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Request Body

application/json
JSON
{
  
"settings": {
  
  
"logo": "string",
  
  
"white_logo": "string",
  
  
"featured_image": "string",
  
  
"site_title": "string",
  
  
"disable_global_posts": "string",
  
  
"access": [
  
  
  
"string"
  
  
],
  
  
"auth_content": "string",
  
  
"auth_redirect": "string",
  
  
"restricted_role_content": "string",
  
  
"logo_permalink": "string",
  
  
"logo_permalink_type": "string",
  
  
"auth_url": "string",
  
  
"cutsom_auth_url": "string",
  
  
"auth_form_type": "string",
  
  
"explicit_registration": "string",
  
  
"use_custom_signup_page": "string",
  
  
"custom_signup_url": "string"
  
}
}

Responses

Successful response

application/json
JSON
{
  
"message": "string",
  
"redirect_url": "string"
}

Playground

Authorization
Body

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation