ForumCommentsApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| createForumComment | POST /community/comments | Create a new comment on a post. |
| deleteForumComment | DELETE /community/comments/{comment_id} | Delete a comment. |
| getForumCommentById | GET /community/comments/{comment_id} | Get a specific comment by its ID. |
| listForumCommentsByPost | GET /community/comments/post/{post_id} | List comments for a specific post. |
| updateForumComment | PUT /community/comments/{comment_id} | Update an existing comment. |
createForumComment
CommentResponse createForumComment(CreateCommentRequest)
Create a new comment on a post.
Posts a new comment or reply to a forum discussion. When parent_comment_id is provided, creates a threaded reply. Requires active forum profile association. Returns the created comment with author details and engagement metrics.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| CreateCommentRequest | CreateCommentRequest | Comment creation request with content, post ID, and optional parent comment ID |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
deleteForumComment
EmptyResponse deleteForumComment(comment_id)
Delete a comment.
Permanently removes a comment from the discussion. Only the original author can delete their own comments, or users with forum.comments.delete_any or forum.admin.full_access permissions. Deletion may cascade to child replies depending on database configuration.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| comment_id | Long | Unique identifier of the comment to delete | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
getForumCommentById
CommentResponse getForumCommentById(comment_id)
Get a specific comment by its ID.
Retrieves detailed information for a single comment including author profile, content, engagement metrics, edit history, and moderation status. Useful for direct comment linking and detailed comment views.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| comment_id | Long | Unique identifier of the comment to retrieve | [default to null] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listForumCommentsByPost
PaginatedResponse_CommentResponse listForumCommentsByPost(post_id, page, per_page)
List comments for a specific post.
Retrieves paginated comments and replies for a forum post. Returns top-level comments with nested replies organized in threaded structure. Includes author information, engagement metrics, and moderation status. Defaults to 20 comments per page.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| post_id | Long | Forum post ID to retrieve comments for | [default to null] |
| page | Integer | Page number for pagination, defaults to 1 | [optional] [default to null] |
| per_page | Integer | Number of comments per page, defaults to 20 | [optional] [default to null] |
Return type
PaginatedResponse_CommentResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
updateForumComment
CommentResponse updateForumComment(comment_id, UpdateCommentRequest)
Update an existing comment.
Modifies comment content with permission verification. Only the original author can edit their own comments, or users with forum.comments.edit_any or forum.admin.full_access permissions. Updates are tracked with edit timestamps.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| comment_id | Long | Unique identifier of the comment to update | [default to null] |
| UpdateCommentRequest | UpdateCommentRequest | Comment update request containing new content |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8