---
title: "Report a data correction"
method: POST
path: "/v1/me/reports"
tags: ["Account"]
---

# Report a data correction

`POST /v1/me/reports`

## Request

- Base URL: `https://api.gunspec.io`
- URL: `https://api.gunspec.io/v1/me/reports`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Flags incorrect, missing, or outdated specification data on a firearm. Reports are reviewed by staff before the catalog changes.

Requires an API key belonging to a user account. Acts on the calling account's own data.

## Request body

- object
  - `firearmId` string, required: Slug of the firearm this row belongs to.
  - `section` 'game-stats' | 'specs' | 'ballistics' | 'barrel' | 'materials' | 'operating' | 'calibers' | 'users' | 'description', required: Which part of the record the report is about.
  - `issueType` 'incorrect' | 'missing' | 'outdated', required: What kind of problem: `incorrect`, `missing`, `outdated`.
  - `description` string, required: Prose summary of the record, where one has been written.
  - `suggestedValue` string: What the reporter believes the value should be.
  - `references` string[]: Pages the reporter cited in support.

## Response `201`

The created report

- object
  - `success` boolean, required: Always true on a successful response. Every error carries `false` and an `error` object instead.
  - `data` DataReport, required: A community-submitted data correction against a firearm.
    - `id` string, required: Opaque report id.
    - `firearmId` string, required: Slug of the firearm this row belongs to.
    - `section` string, required: Which part of the record the report is about.
    - `issueType` 'incorrect' | 'missing' | 'outdated', required: What a data report says is wrong.
    - `description` string, required: Prose summary of the record, where one has been written.
    - `suggestedValue` string, nullable: What the reporter believes the value should be.
    - `references` string[]: Pages the reporter cited in support.
    - `status` 'pending' | 'reviewed' | 'resolved' | 'dismissed', required: Lifecycle of a data report.
    - `createdAt` string: When the record was first added, `YYYY-MM-DD HH:MM:SS` in UTC.
    - `reviewedAt` string, nullable: When staff reviewed it, or null while it is pending.

## Other responses

- `400`: Validation error
- `401`: Missing or invalid API key
- `403`: The credential is valid and the caller is not permitted. Three causes, none of which reissuing a key changes: the plan is below the endpoint's tier, the account is suspended, or the key is not attached to the thing being acted on, meaning a user account for `/v1/me` or a shop for `/v1/vendor`. Distinct from 401, which means the credential is missing, malformed or expired and a new one can work.
- `413`: The request body is larger than this endpoint accepts, which is 1 MB for a JSON body. Refused from `Content-Length` before the body is read, so nothing was stored and the request can be split and resent. `error.maxBytes` carries the limit.
- `429`: A limit was reached. `RATE_LIMITED` is the per-minute limit: wait `Retry-After` seconds (a minute) and retry. `DAILY_CAP_EXCEEDED` is the plan's daily limit, per key: nothing will be served until the counters return to zero at midnight UTC. `MONTHLY_CAP_EXCEEDED` is the plan's monthly allowance, for the whole account: nothing will be served until midnight UTC on the first of next month, or until the plan changes. For both, `Retry-After` is the seconds until then and `error.resetsAt` says when as an instant. Calls made after a refusal are refused too and do not spend the month, and a free key that keeps calling is paused, so stop at the first one and resume at the reset.
- `500`: Internal server error

---

[API](https://skmtc.dev/gunspec/apis/gunspec-io-api.md) · [All operations](https://skmtc.dev/gunspec/apis/gunspec-io-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gunspec/apis/gunspec-io-api/revisions/f2e974d8b05c?raw)