ForumPostsApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| changeForumPostStatus | PATCH /community/posts/{post_id}/status | Change post status (Moderator only) |
| createForumPost | POST /community/posts | Create a new community post |
| deleteForumPost | DELETE /community/posts/{post_id} | Delete a post permanently |
| getForumPostById | GET /community/posts/{post_id} | Get a specific post by ID |
| getMyVoteForPost | GET /community/posts/{post_id}/my-vote | Get current user’s vote on a post |
| listForumPostsByCategory | GET /community/posts/category/{category_id} | List posts by category with pagination |
| listForumPostsByProfile | GET /community/posts/profile/{profile_id} | List posts by a user profile with pagination |
| updateForumPost | PUT /community/posts/{post_id} | Update an existing post |
changeForumPostStatus
PostResponse changeForumPostStatus(post_id, ChangePostStatusRequest)
Change post status (Moderator only)
Allows moderators to update the publication status of a post. Status changes control post visibility and can include draft, published, archived, or removed states. Used for content moderation and post lifecycle management.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| post_id | Long | Unique identifier of the post to update | [default to null] |
| ChangePostStatusRequest | ChangePostStatusRequest | New status to apply to the post |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
createForumPost
PostResponse createForumPost(CreatePostRequest)
Create a new community post
Allows authenticated users to publish a new post in a forum category. The post requires a title, content, category assignment, and unique slug. Returns the created post details including engagement metrics and author information.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| CreatePostRequest | CreatePostRequest | Post creation data including title, content, category, and slug |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
deleteForumPost
EmptyResponse deleteForumPost(post_id)
Delete a post permanently
Removes a post and all its associated data from the community. Only the post author or moderators with appropriate permissions can delete posts. This action cannot be undone and will remove all comments, votes, and engagement metrics.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| post_id | Long | Unique identifier of the post to delete | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getForumPostById
PostResponse getForumPostById(post_id, authorization)
Get a specific post by ID
Retrieves detailed information about a community post including its content, author, engagement metrics (votes, comments, views), and category. Visibility depends on post status and user permissions. Moderators can view all posts regardless of status.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| post_id | Long | Unique identifier of the post to retrieve | [default to null] |
| authorization | String | Optional JWT bearer token for authenticated requests | [optional] [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getMyVoteForPost
MyVoteResponse getMyVoteForPost(post_id)
Get current user’s vote on a post
Retrieves the authenticated user’s voting status for a specific post. Returns whether the user has upvoted, downvoted, or has not voted on the post. Used to display the correct vote state in the community interface.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| post_id | Long | Unique identifier of the post to check vote status for | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listForumPostsByCategory
PaginatedResponse_PostResponse listForumPostsByCategory(category_id, page, per_page)
List posts by category with pagination
Returns all published posts within a specific forum category. Results are paginated and ordered by creation date (newest first). Includes basic post information, author details, and engagement metrics for each post in the list.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| category_id | Long | Category ID to filter posts by | [default to null] |
| page | Integer | Page number for pagination (default: 1) | [optional] [default to null] |
| per_page | Integer | Number of posts per page (default: 10) | [optional] [default to null] |
Return type
PaginatedResponse_PostResponse
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listForumPostsByProfile
PaginatedResponse_PostResponse listForumPostsByProfile(profile_id, page, per_page)
List posts by a user profile with pagination
Returns all posts created by a specific community member. Profile owners and moderators can view all posts including drafts and unpublished content. Other users only see published posts. Requires authentication to access profile-specific content.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| profile_id | Long | Profile ID of the user whose posts to retrieve | [default to null] |
| page | Integer | Page number for pagination (default: 1) | [optional] [default to null] |
| per_page | Integer | Number of posts per page (default: 10) | [optional] [default to null] |
Return type
PaginatedResponse_PostResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
updateForumPost
PostResponse updateForumPost(post_id, UpdatePostRequest)
Update an existing post
Allows post authors to edit their published content, including title, body text, slug, and category assignment. Moderators can update any post. Only the post owner or moderators with appropriate permissions can perform updates.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| post_id | Long | Unique identifier of the post to update | [default to null] |
| UpdatePostRequest | UpdatePostRequest | Updated post data including title, content, slug, and category |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8