Skip to content

Validates and stores the Progressive Web App settings, marking a custom icon as permanent media and recording its pixel dimensions.

app_name is required and length-capped, as is short_name. icon_source must be default or custom, and a custom source without a resolvable icon is rejected. install_position accepts only top or bottom. Icon dimensions are validated before the media row is activated.

Endpoint

  • Method: POST

  • Path: /admin/pwa-settings

  • Edition: PRO

  • Controller: PwaController@saveSettings

  • Route source: fluent-community-pro/app/Modules/Pwa/Http/pwa_api.php:9

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

  • Requires FluentCommunity Pro; this is the PWA module settings endpoint despite its generic path name.

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 Save Settings

POST
/admin/pwa-settings

Validates and stores the Progressive Web App settings, marking a custom icon as permanent media and recording its pixel dimensions.

Controller: PwaController@saveSettings
Route source: fluent-community-pro/app/Modules/Pwa/Http/pwa_api.php:9

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Request Body

application/json
JSON
{
  
"settings": {
  
  
"app_name": "string",
  
  
"background_color": "string",
  
  
"custom_icon": "string",
  
  
"icon_sizes": "string",
  
  
"icon_source": "string",
  
  
"install_dismissible": "string",
  
  
"install_entry": "string",
  
  
"install_position": "string",
  
  
"short_name": "string"
  
}
}

Responses

Successful response

application/json
JSON
{
  
"message": "string",
  
"settings": {
  
  
"app_name": "string",
  
  
"background_color": "string",
  
  
"custom_icon": "string",
  
  
"icon_sizes": "string",
  
  
"icon_source": "string",
  
  
"install_dismissible": "string",
  
  
"install_entry": "string",
  
  
"install_position": "string",
  
  
"short_name": "string"
  
}
}

Playground

Authorization
Body

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation