ForumModerationApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| assignForumModerator | POST /community/moderation/assign-moderator | Assign a community member as a moderator for a specific category. |
| banForumProfile | POST /community/moderation/profiles/{profile_id}/ban | Ban a community member from forum participation. |
| hideForumComment | POST /community/moderation/comments/{comment_id}/hide | Hide a comment from community visibility. |
| hideForumPost | POST /community/moderation/posts/{post_id}/hide | Hide a post from community visibility. |
| removeForumModerator | POST /community/moderation/remove-moderator | Revoke moderator privileges from a community member. |
| unbanForumProfile | POST /community/moderation/profiles/{profile_id}/unban | Restore forum participation privileges to a banned member. |
| unhideForumComment | POST /community/moderation/comments/{comment_id}/unhide | Restore visibility of a previously hidden comment. |
| unhideForumPost | POST /community/moderation/posts/{post_id}/unhide | Restore visibility of a previously hidden post. |
assignForumModerator
ModeratorAssignmentResponse assignForumModerator(AssignModeratorRequest)
Assign a community member as a moderator for a specific category.
Grants moderation privileges to a forum profile for a designated category, enabling them to manage content, hide/unhide posts and comments, and enforce community guidelines within their assigned scope. This operation is restricted to administrators only.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| AssignModeratorRequest | AssignModeratorRequest | Request containing the profile ID to promote and the category ID for their moderation scope |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
banForumProfile
ModerationActionResponse banForumProfile(profile_id)
Ban a community member from forum participation.
Restricts a forum profile from creating posts, comments, and other community interactions. This is the most severe moderation action, typically used for repeat offenders, spam accounts, or serious violations of community guidelines. Banned profiles can be unbanned if circumstances change.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| profile_id | Long | The unique identifier of the forum profile to ban from community participation | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
hideForumComment
ModerationActionResponse hideForumComment(comment_id)
Hide a comment from community visibility.
Removes a comment from public view while preserving it in the database for audit purposes. This action is used to moderate comments that violate community standards, contain inappropriate content, or require review. Hidden comments can be restored later if deemed acceptable.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| comment_id | Long | The unique identifier of the comment to hide from community view | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
hideForumPost
ModerationActionResponse hideForumPost(post_id)
Hide a post from community visibility.
Removes a post from public view while preserving it in the database for audit purposes. This action is used to moderate content that violates community guidelines, is inappropriate, or requires review. Hidden posts can be restored later if deemed acceptable.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| post_id | Long | The unique identifier of the post to hide from community view | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
removeForumModerator
EmptyResponse removeForumModerator(RemoveModeratorRequest)
Revoke moderator privileges from a community member.
Removes moderation privileges from a forum profile, preventing them from performing moderation actions. This operation is used when a moderator’s term ends, privileges are revoked, or when restructuring moderation teams. Restricted to administrators only.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| RemoveModeratorRequest | RemoveModeratorRequest | Request containing the moderator assignment ID to revoke |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
unbanForumProfile
ModerationActionResponse unbanForumProfile(profile_id)
Restore forum participation privileges to a banned member.
Removes ban restrictions from a forum profile, allowing them to resume community participation. This action is used when a ban period expires, circumstances change, or when a member has successfully appealed their ban and demonstrated commitment to following community guidelines.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| profile_id | Long | The unique identifier of the forum profile to restore participation privileges for | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
unhideForumComment
ModerationActionResponse unhideForumComment(comment_id)
Restore visibility of a previously hidden comment.
Makes a hidden comment visible again to the community, reversing a prior hide action. This enables moderators to reinstate comments that were hidden but are now deemed acceptable, or when a comment has been edited to meet community guidelines.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| comment_id | Long | The unique identifier of the comment to restore visibility for | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
unhideForumPost
ModerationActionResponse unhideForumPost(post_id)
Restore visibility of a previously hidden post.
Makes a hidden post visible again to the community, reversing a prior hide action. This allows moderators to reinstate content that was hidden but is now deemed appropriate, or when a post has been edited to comply with community standards.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| post_id | Long | The unique identifier of the post to restore visibility for | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8