Skip to content

Turns notifications about a member you already follow on or off, without changing the follow itself.

The follow relationship stores this as a level, so the toggle flips between plain following and following with notifications. Calling it when you do not follow the member, or when you have blocked them, is an error.

Endpoint

  • Method: POST

  • Path: /profile/{username}/notification

  • Edition: PRO

  • Controller: FollowController@toggleNotification

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

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

  • Requires FluentCommunity Pro with the followers_module feature enabled.

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 Toggle Profile Notification

POST
/profile/{username}/notification

Turns notifications about a member you already follow on or off, without changing the follow itself.

Controller: FollowController@toggleNotification
Route source: fluent-community-pro/app/Http/Routes/api.php:136

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Parameters

Path Parameters

username*

Username extracted from the URL path.

Type
string
Required

Responses

Successful response

application/json
JSON
{
  
"follow": {
  
  
"created_at": "string",
  
  
"followed_id": "string",
  
  
"follower_id": "string",
  
  
"id": 0,
  
  
"level": 0,
  
  
"updated_at": "string"
  
},
  
"message": "string"
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation