Skip to main content

Overview

Returns a function that allows a space moderator to take action on a comment report. Available actions are: remove the comment, ban the comment’s author from the space, or dismiss the report.
Requires the authenticated user to have admin or moderator role in the target space.

Usage Example

Parameters

string
required
The ID of the space the report belongs to.
string
required
The ID of the report to action.
string
required
The ID of the reported comment.
Array<'remove-comment' | 'ban-user' | 'dismiss'>
required
One or more actions to take:
  • remove-comment — Removes the comment.
  • ban-user — Bans the comment’s author from the space (requires userId).
  • dismiss — Marks the report as dismissed.
string
required
A moderator note describing the action taken.
string
The ID of the user to ban. Required when ban-user is included in actions.
string
The reason for banning, if applicable.

Returns

Returns Promise<{ message: string; code: string }>.

Notes