Skip to main content
Create Report
Submits a report on an entity, comment, or chat message. If an open report already exists for the target, the authenticated user’s report is added to it (increments reporterCount). If the same user already reported that open report, a 200 is returned without creating a duplicate. Resolved reports (dismissed / actioned) are closed: a later report of the same target creates a new report rather than reopening the old one. A target therefore has at most one open report at a time, alongside any number of resolved ones. Authentication required. Rate limit: 25 requests per 5 minutes.

Body Parameters

string
required
The UUID of the entity, comment, or chat message being reported. For a message this is the message id — the conversation is resolved server-side, so no conversationId is needed.
string
required
The type of content being reported. One of: entity, comment, message.
string
required
The reason for the report. Must be one of: spam, inappropriateContent, harassment, misinformation, hateSpeech, violence, illegalActivity, selfHarm, other. Any other value is rejected with report/invalid-body — use other plus details for anything the taxonomy doesn’t cover.
string
Optional additional context or description provided by the reporter.

Response

Returns 201 Created when a new report is created:
Returns 200 OK when an existing report is updated with a new reporter:
Returns 200 OK when the user has already reported this target:

Error Responses

The error message reflects the reported type, e.g. "entity not found" or "comment not found".
A user cannot report content they authored.
Only members of a conversation may report a message in it. Applies to targetType: "message" only.
Returned for a malformed targetId, an unknown targetType, or a reason outside the accepted set.