Skip to content

Blocks a member, converting any existing follow relationship into a block rather than creating a second row.

Blocking yourself is rejected, as is blocking anyone who holds community-moderator access. Community moderators are themselves forbidden from blocking anybody.

Endpoint

  • Method: POST

  • Path: /profile/{username}/block

  • Edition: PRO

  • Controller: FollowController@block

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

  • 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 Block Profile User

POST
/profile/{username}/block

Blocks a member, converting any existing follow relationship into a block rather than creating a second row.

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

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",
  
"xprofile": {
  
  
"avatar": "string",
  
  
"badge": "string",
  
  
"created_at": "string",
  
  
"display_name": "string",
  
  
"id": "string",
  
  
"is_verified": 0,
  
  
"last_activity": "string",
  
  
"meta": {
  
  
  
"cover_photo": "string",
  
  
  
"short_description_rendered": "string",
  
  
  
"website": "string"
  
  
},
  
  
"permalink": "string",
  
  
"short_description": "string",
  
  
"status": "string",
  
  
"total_points": 0,
  
  
"updated_at": "string",
  
  
"user": {
  
  
  
"ID": 0,
  
  
  
"display_name": "string",
  
  
  
"photo": "string",
  
  
  
"user_email": "string",
  
  
  
"user_login": "string",
  
  
  
"user_nicename": "string",
  
  
  
"user_registered": "string",
  
  
  
"user_status": "string",
  
  
  
"user_url": "string"
  
  
},
  
  
"user_id": 0,
  
  
"username": "string"
  
}
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation