---
title: "Open a support ticket"
method: POST
path: "/v1/me/support"
tags: ["Account"]
---

# Open a support ticket

`POST /v1/me/support`

## Request

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

Opens a support ticket against your account. **Requires a paid plan (Builder or above).**

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

## Request body

- object
  - `subject` string, required: One-line summary of the issue.
  - `description` string, required: Prose summary of the record, where one has been written.
  - `category` 'billing' | 'technical' | 'data_quality' | 'feature_request' | 'other': What the ticket is about. Not a firearm or attachment category.
  - `priority` 'low' | 'normal' | 'high' | 'urgent': Triage priority you are asking for. Staff may change it.

## Response `201`

The created ticket

- object
  - `success` boolean, required: Always true on a successful response. Every error carries `false` and an `error` object instead.
  - `data` SupportTicket, required
    - `id` string, required: Opaque ticket id.
    - `subject` string, required: One-line summary of the issue.
    - `description` string: Prose summary of the record, where one has been written.
    - `status` 'open' | 'in_progress' | 'waiting' | 'resolved' | 'closed', required: Lifecycle of a support ticket. `waiting` means we are waiting on the customer.
    - `priority` 'low' | 'normal' | 'high' | 'urgent', required: Support ticket priority.
    - `category` string, nullable: What the ticket is about: `billing`, `technical`, `data_quality`, `feature_request`, `other`.
    - `reply_count` integer: How many replies the thread holds.
    - `created_at` string: When the ticket was opened, ISO 8601.
    - `updated_at` string: When the ticket last changed, ISO 8601.
    - `closed_at` string, nullable: When it was closed, or null while it is open.

## 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)