Skip to content

Applies a small state change to a post — pinning it, changing its priority, or turning comments off.

Moderators may set is_sticky, priority and comments_disabled; a plain author is restricted to comments_disabled only. Making a post sticky first clears the sticky flag from every other post in the same space, so a space holds at most one pinned post.

Endpoint

  • Method: PATCH

  • Path: /feeds/{feed_id}

  • Edition: Core

  • Controller: FeedsController@patchFeed

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

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

  • Requires the post author, a community moderator, or a community admin, either globally or in the space.

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.

PATCH Patch Feed

PATCH
/feeds/{feed_id}

Applies a small state change to a post — pinning it, changing its priority, or turning comments off.

Controller: FeedsController@patchFeed
Route source: fluent-community/app/Http/Routes/api.php:45

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Parameters

Path Parameters

feed_id*

Feed ID extracted from the URL path.

Type
integer
Required

Request Body

application/json
JSON
{
  
"is_sticky": "string"
}

Responses

Successful response

application/json
JSON
{
  
"feed": {
  
  
"comments_count": 0,
  
  
"content_type": "string",
  
  
"created_at": "string",
  
  
"expired_at": "string",
  
  
"featured_image": "string",
  
  
"id": 0,
  
  
"is_sticky": 0,
  
  
"message": "string",
  
  
"message_rendered": "string",
  
  
"meta": {
  
  
  
"last_edited": {
  
  
  
  
"time": "string",
  
  
  
  
"user_id": 0
  
  
  
}
  
  
},
  
  
"parent_id": "string",
  
  
"permalink": "string",
  
  
"priority": 0,
  
  
"privacy": "string",
  
  
"reactions_count": 0,
  
  
"scheduled_at": "string",
  
  
"slug": "string",
  
  
"space": {
  
  
  
"cover_photo": "string",
  
  
  
"created_at": "string",
  
  
  
"created_by": "string",
  
  
  
"description": "string",
  
  
  
"id": 0,
  
  
  
"logo": "string",
  
  
  
"parent_id": "string",
  
  
  
"privacy": "string",
  
  
  
"serial": "string",
  
  
  
"settings": {
  
  
  
  
"can_request_join": "string",
  
  
  
  
"custom_lock_screen": "string",
  
  
  
  
"default_comment_sort_by": "string",
  
  
  
  
"default_post_sort_by": "string",
  
  
  
  
"disable_layout_style": "string",
  
  
  
  
"disable_post_sort_by": "string",
  
  
  
  
"document_access": "string",
  
  
  
  
"document_library": "string",
  
  
  
  
"document_upload": "string",
  
  
  
  
"emoji": "string",
  
  
  
  
"hide_members_count": "string",
  
  
  
  
"layout_style": "string",
  
  
  
  
"links": [
  
  
  
  
  
{
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
}
  
  
  
  
],
  
  
  
  
"media_access": "string",
  
  
  
  
"media_gallery": "string",
  
  
  
  
"members_page_status": "string",
  
  
  
  
"og_image": "string",
  
  
  
  
"restricted_post_only": "string",
  
  
  
  
"shape_svg": "string",
  
  
  
  
"show_paywalls": "string",
  
  
  
  
"show_sidebar": "string",
  
  
  
  
"topic_required": "string"
  
  
  
},
  
  
  
"slug": "string",
  
  
  
"status": "string",
  
  
  
"title": "string",
  
  
  
"type": "string",
  
  
  
"updated_at": "string"
  
  
},
  
  
"space_id": "string",
  
  
"status": "string",
  
  
"title": "string",
  
  
"type": "string",
  
  
"updated_at": "string",
  
  
"user_id": "string"
  
},
  
"message": "string"
}

Playground

Authorization
Variables
Key
Value
Body

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation