> ## Documentation Index
> Fetch the complete documentation index at: https://docs.patch.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# Reserve a name, so nobody new can take it

> Whoever holds it already keeps it.



## OpenAPI

````yaml /api-reference/openapi.json post /staff/reserved-names
openapi: 3.1.0
info:
  title: Patch API
  version: 1.0.0
  description: >-
    The public API behind patch.gg, the desktop app and pch. Changes within v1
    are additive only. Errors are { error: { code, message, details } }; branch
    on code.
servers:
  - url: https://patch.gg/api/v1
security: []
paths:
  /staff/reserved-names:
    post:
      tags:
        - Staff
      summary: Reserve a name, so nobody new can take it
      description: Whoever holds it already keeps it.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 32
                reason:
                  type: string
                  enum:
                    - platform
                    - store
                    - tool
                    - game
                    - other
              required:
                - name
                - reason
      responses:
        '201':
          description: Reserved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReservedName'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Not signed in
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearer: []
components:
  schemas:
    ReservedName:
      type: object
      properties:
        name:
          type: string
          example: patch
        reason:
          anyOf:
            - type: string
              enum:
                - platform
                - store
                - tool
                - game
                - other
            - type: string
          description: 'Why: platform, store, tool, game or other'
        taken:
          type: boolean
          description: >-
            An account holds the name already (reserving it doesn't take it
            away)
      required:
        - name
        - reason
        - taken
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: version_exists
            message:
              type: string
            details: {}
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: An API key (pch_...) or the token from pch login.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.