Report User

Post
/api/v1/moderation.reportUser

Changelog

Version Description
6.4.0 Added
Header parameters
X-Auth-Token
stringRequired

The authenticated user token.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The authenticated user ID.

ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example 1
{
  "userId": "ByehQjC44FwMeiLbX",
  "description": "test"
}
object
userId
string Required

The ID of the user to be reported.

ExampleByehQjC44FwMeiLbX
description
string Required

The reason for reporting the user.

Exampletest
Responses
200

OK

Success
{
  "success": true
}
object
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "error": "must have required property 'userId' [invalid-params]",
  "errorType": "invalid-params"
}
object
success
boolean
error
string
errorType
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string