Merges the submitted messaging settings over the stored ones and saves the realtime socket credentials when realtime chat is switched on.

Keys not already present in the stored config are discarded. socket_config is only written when realtime_enabled is yes in the merged result.

Endpoint

• Method: POST

• Path: /admin/messaging-setting

• Edition: PRO

• Controller: ProAdminController@updateMessagingSettings

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

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

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

• Requires FluentCommunity Pro and the Fluent Messaging plugin.

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

POST

/admin/messaging-setting

Merges the submitted messaging settings over the stored ones and saves the realtime socket credentials when realtime chat is switched on.

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

Authorizations

ApplicationPasswords

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

Type

API Key (header: Authorization)

Request Body

application/json

{

  

"settings": {

  

  

"realtime_enabled": "string"

  

},

  

"socket_config": [

  

  

"string"

  

]

}

Responses

Successful response

Content-Type

application/json

{

  

"message": "string",

  

"settings": {

  

  

"messaging_email_frequency": "string",

  

  

"messaging_email_status": "string",

  

  

"points_to_initiate_message": 0,

  

  

"realtime_enabled": "string",

  

  

"socket_provider": "string",

  

  

"who_can_initiate_message": "string"

  

}

}

POST

/admin/messaging-setting

Playground

Authorization

ApplicationPasswords

Body

Samples

Powered by VitePress OpenAPI