ForumReportsApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| createForumReport | POST /community/reports | Create a new report for a post or comment (Requires authenticated user) |
| getForumReportById | GET /community/reports/{report_id} | Get details of a specific report by ID (Admin/Moderator only) |
| listForumReports | GET /community/reports | List reports (Admin/Moderator only, paginated, filter by status) |
| updateForumReportStatus | PATCH /community/reports/{report_id}/status | Update the status of a report (Admin/Moderator only) |
createForumReport
ReportResponse createForumReport(CreateReportRequest)
Create a new report for a post or comment (Requires authenticated user)
Allows community members to report inappropriate or rule-violating content. Users must have `forum.reports.create` permission and an active forum profile to submit reports.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| CreateReportRequest | CreateReportRequest | Report details including target ID, type, and reason |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
getForumReportById
ReportResponse getForumReportById(report_id)
Get details of a specific report by ID (Admin/Moderator only)
Retrieves full details of a specific content report for moderation review. Requires `forum.reports.view` or `forum.admin.full_access` permission.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| report_id | Long | ID of the report to retrieve | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
listForumReports
PaginatedResponse_ReportResponse listForumReports()
List reports (Admin/Moderator only, paginated, filter by status)
Retrieves paginated list of content reports for moderation review. Supports filtering by report status. Requires `forum.reports.view` or `forum.admin.full_access` permission.
Parameters
This endpoint does not need any parameter.
Return type
PaginatedResponse_ReportResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
updateForumReportStatus
ReportResponse updateForumReportStatus(report_id, UpdateReportStatusRequest)
Update the status of a report (Admin/Moderator only)
Allows moderators to resolve or dismiss reported content. Updates report status to track moderation actions. Requires `forum.reports.resolve` or `forum.admin.full_access` permission.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| report_id | Long | ID of the report to update | [default to null] |
| UpdateReportStatusRequest | UpdateReportStatusRequest | New status for the report (resolved, dismissed, etc.) |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8