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 and the child spaces where they are an active member, and ends their membership of those spaces’ chats (requires reason; userId is optional and must be the author if sent).
  • dismiss — Marks the report as dismissed.
string
required
A moderator note describing the action taken.
string
Optional. The server bans the author of the reported content; if sent, this must be that author.
string
The reason for banning, if applicable.

Returns

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

Notes