Report a comment

POST

/v1/comments/{id}/reports

curl --request POST \
  --url https://api.gampeon.com/v1/comments/1/reports \
  --header 'Content-Type: application/json' \
  --data '{ "category": "illegal_content", "explanation": "example", "reporterName": "example", "reporterEmail": "hello@example.com", "goodFaith": true }'

• Production

Same rules as reporting a post. A copy of the comment is kept with the report.

Not available with access tokens.

Rate limit: 10 per hour per IP (together with other reports).

Authorizations

• None
• session

Parameters

Path Parameters

id

required

integer

>= 1

Comment ID

Request Body^required

Media typeapplication/json

object

category

required

string

Allowed values: illegal_content harassment hate_speech violence_threat child_safety spam copyright other

explanation

required

string

>= 20 characters <= 5000 characters

reporterName

string

>= 2 characters <= 120 characters

reporterEmail

string format: email

<= 254 characters

goodFaith

required

Confirms the report is made in good faith

Responses

201

Report received (200 if you already reported this comment)

Media typeapplication/json

object

reportId

required

string

status

required

Allowed value: open

Example

{
  "status": "open"
}

400

Error codes: invalid_field

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

403

Error codes: token_not_allowed

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

404

Error codes: not_found

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

422

Error codes: good_faith_confirmation_required

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

429

Limit: 10 per hour per IP (together with other reports). Error codes: rate_limited

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}