Pins or unpins a top-level comment so it sorts above the rest of the thread.
is_sticky is the only field accepted. Pinning first clears the sticky flag from every other comment on the same post, so a post can only ever have one pinned comment. Replies cannot be pinned.
Requires a community moderator or community admin, either globally or within the post 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.
Pins or unpins a top-level comment so it sorts above the rest of the thread.
is_stickyis the only field accepted. Pinning first clears the sticky flag from every other comment on the same post, so a post can only ever have one pinned comment. Replies cannot be pinned.Endpoint
Method:
PATCHPath:
/feeds/{feed_id}/comments/{comment_id}Edition: Core
Controller:
CommentsController@patchCommentRoute source:
fluent-community/app/Http/Routes/api.php:55Controller source:
fluent-community/app/Http/Controllers/CommentsController.phpRequires a community moderator or community admin, either globally or within the post 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 Comment
Pins or unpins a top-level comment so it sorts above the rest of the thread.
Controller:
CommentsController@patchCommentRoute source:
fluent-community/app/Http/Routes/api.php:55Authorizations
WordPress Application Passwords — use Basic auth with username:application_password.
Parameters
Path Parameters
Feed ID extracted from the URL path.
Comment ID extracted from the URL path.
Request Body
Responses
Successful response
Playground
Authorization
Variables
Body
Samples