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

# Create a support ticket

> File an incident (something is broken) or a feature request. Urgent-priority
tickets are escalated to the Hyperprop team immediately — reserve them for
severe issues such as blocked trading or wrong balances.

Attachments must be uploaded first via the uploads endpoint; pass the
returned paths here.

## Example

```bash
curl -X POST "https://api.hyperprop.com/platform/v1/organization/support/tickets" \
  -H "X-API-Key: hp_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "incident",
    "title": "Fills missing on ES orders",
    "description": "Orders filled on the exchange but no fills showed in the terminal.",
    "accountIds": ["1e7c9f02-e980-4410-b81f-39599bb6fa47"],
    "occurredAt": "2026-08-27T13:45:00Z",
    "priority": "high"
  }'
```


**Authentication:** Accepts either `Authorization: Bearer <jwt>` (dashboard) or `X-API-Key: hp_live_...` (programmatic).



## OpenAPI

````yaml /api-reference/openapi.json post /v1/organization/support/tickets
openapi: 3.0.0
info:
  title: Hyperprop Platform API
  version: 1.0.0
  description: >-
    REST API for the Hyperprop Trading Platform — provision evaluation and
    funded trading accounts, manage traders and plans, react to account
    lifecycle events via signed webhooks, and reconcile billing. Built for prop
    firms integrating from their own backend.


    Authentication, quick start, error handling, idempotency, pagination, custom
    metadata, webhooks, and the MCP connector are documented at
    https://docs.hyperprop.com.
  x-logo:
    url: https://app.hyperprop.com/logo-icon.svg
    altText: Hyperprop
    href: https://hyperprop.com
servers:
  - url: https://api.hyperprop.com/platform
    description: Production
security: []
tags:
  - name: Authentication
    description: >-
      User authentication - signup, signin, signout, password reset, email
      verification, OAuth, and MFA
  - name: User
    description: >-
      User account management - profile, notifications, agreements, dismissals,
      and audit logs. Requires Bearer token.
  - name: Organization
    description: >-
      Organization management - profile, team, trading accounts, plans, and
      rules. Supports **dual authentication**: Bearer JWT token (dashboard
      users) OR X-API-Key (programmatic access).
  - name: Demo
    description: >-
      Demo account management - import, list, and delete demo trading accounts.
      Requires Bearer token.
  - name: Market Data
    description: CME futures contracts and market data. Requires Bearer token.
  - name: System
    description: System endpoints - health checks and connectivity
paths:
  /v1/organization/support/tickets:
    post:
      tags:
        - Organization
      summary: Create a support ticket
      description: >-
        File an incident (something is broken) or a feature request.
        Urgent-priority

        tickets are escalated to the Hyperprop team immediately — reserve them
        for

        severe issues such as blocked trading or wrong balances.


        Attachments must be uploaded first via the uploads endpoint; pass the

        returned paths here.


        ## Example


        ```bash

        curl -X POST
        "https://api.hyperprop.com/platform/v1/organization/support/tickets" \
          -H "X-API-Key: hp_live_your_key_here" \
          -H "Content-Type: application/json" \
          -d '{
            "type": "incident",
            "title": "Fills missing on ES orders",
            "description": "Orders filled on the exchange but no fills showed in the terminal.",
            "accountIds": ["1e7c9f02-e980-4410-b81f-39599bb6fa47"],
            "occurredAt": "2026-08-27T13:45:00Z",
            "priority": "high"
          }'
        ```



        **Authentication:** Accepts either `Authorization: Bearer <jwt>`
        (dashboard) or `X-API-Key: hp_live_...` (programmatic).
      operationId: postV1OrganizationSupportTickets
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model608'
      responses:
        '201':
          description: Created — the new ticket
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model610'
        '400':
          description: Validation error
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model294'
        '500':
          description: Internal error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model295'
      security:
        - Bearer: []
        - X-API-Key: []
components:
  schemas:
    Model608:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/type'
        title:
          type: string
          example: Fills missing on ES orders since this morning
          minLength: 1
          maxLength: 200
          x-convert:
            trim: true
        description:
          type: string
          example: >-
            Orders 123/456 filled on the exchange but no fills showed in the
            terminal…
          minLength: 1
          maxLength: 20000
          x-convert:
            trim: true
        accountIds:
          $ref: '#/components/schemas/Model604'
        occurredAt:
          type: string
          description: When the issue happened (ISO 8601)
          x-format:
            isoDate: true
        priority:
          $ref: '#/components/schemas/Model605'
        attachments:
          $ref: '#/components/schemas/Model607'
      required:
        - type
        - title
        - description
    Model610:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model609'
    Model294:
      type: object
      properties:
        statusCode:
          type: number
          example: 401
        error:
          type: string
          example: Unauthorized
        message:
          type: string
          example: Invalid or expired token
        code:
          type: string
          example: UNAUTHORIZED
    Model295:
      type: object
      properties:
        statusCode:
          type: number
          example: 500
        error:
          type: string
          example: Internal Server Error
        message:
          type: string
          example: Failed to load tickets
        code:
          type: string
          example: SUPPORT_ERROR
    type:
      type: string
      example: incident
      enum:
        - incident
        - feature_request
    Model604:
      type: array
      description: Affected trading account ids (incidents)
      maxItems: 50
      items:
        type: string
        maxLength: 64
        x-convert:
          trim: true
    Model605:
      type: string
      default: normal
      enum:
        - low
        - normal
        - high
        - urgent
    Model607:
      type: array
      maxItems: 5
      items:
        $ref: '#/components/schemas/Model606'
    Model609:
      type: object
      properties:
        ticket:
          $ref: '#/components/schemas/Model291'
    Model606:
      type: object
      properties:
        path:
          type: string
          description: >-
            Storage path returned by the uploads endpoint. Must belong to your
            organization.
          example: a6fcc0ce-eb28-4f43-b256-96a3144b0d34/1f2e.../screenshot.webp
          maxLength: 500
        name:
          type: string
          example: screenshot.webp
          minLength: 1
          maxLength: 255
        size:
          type: integer
          example: 482133
          minimum: 1
          maximum: 52428800
        contentType:
          $ref: '#/components/schemas/contentType'
      required:
        - path
        - name
        - size
        - contentType
    Model291:
      type: object
      properties:
        id:
          type: string
          example: e4b1a2c3-d4e5-4f60-8192-a3b4c5d6e7f8
          x-format:
            guid: true
        ticketNumber:
          type: integer
          description: Human-friendly sequential reference (#42)
          example: 42
        organizationId:
          type: string
          example: a6fcc0ce-eb28-4f43-b256-96a3144b0d34
          x-format:
            guid: true
        createdByUserId:
          type: string
          example: 0b1c2d3e-4f50-6172-8394-a5b6c7d8e9f0
        createdByEmail:
          type: string
          example: ops@yourfirm.com
        createdByName:
          type: string
          example: Your Firm LLC
        type:
          $ref: '#/components/schemas/type'
        title:
          type: string
          example: Fills missing on ES orders since this morning
        description:
          type: string
          example: Orders 123/456 filled on the exchange but no fills showed…
        accountIds:
          $ref: '#/components/schemas/accountIds'
        occurredAt:
          type: string
          description: When the issue happened (UTC; shown in Eastern Time in the portal)
          example: '2026-08-27T13:45:00.000Z'
          x-format:
            isoDate: true
        priority:
          $ref: '#/components/schemas/priority'
        status:
          $ref: '#/components/schemas/Model288'
        attachments:
          $ref: '#/components/schemas/attachments'
        comments:
          $ref: '#/components/schemas/comments'
        commentCount:
          type: integer
          example: 2
        createdAt:
          type: string
          x-format:
            isoDate: true
        updatedAt:
          type: string
          x-format:
            isoDate: true
    contentType:
      type: string
      example: image/webp
      enum:
        - image/png
        - image/jpeg
        - image/webp
        - image/gif
        - video/mp4
        - video/quicktime
        - video/webm
    accountIds:
      type: array
      description: Trading account ids the report concerns
      example:
        - 1e7c9f02-e980-4410-b81f-39599bb6fa47
      items:
        type: string
    priority:
      type: string
      example: high
      enum:
        - low
        - normal
        - high
        - urgent
    Model288:
      type: string
      description: >-
        open — filed and queued; investigating — our team is on it; resolved —
        done (fixed, shipped, or declined with a reply)
      example: open
      enum:
        - open
        - investigating
        - resolved
    attachments:
      type: array
      items:
        $ref: '#/components/schemas/Model289'
    comments:
      type: array
      description: >-
        Reply thread, oldest first. Empty in list responses — fetch the ticket
        for the full thread.
      items:
        $ref: '#/components/schemas/Model290'
    Model289:
      type: object
      properties:
        path:
          type: string
          description: >-
            Storage path returned by the uploads endpoint. Must belong to your
            organization.
          example: a6fcc0ce-eb28-4f43-b256-96a3144b0d34/1f2e.../screenshot.webp
          maxLength: 500
        name:
          type: string
          example: screenshot.webp
          minLength: 1
          maxLength: 255
        size:
          type: integer
          example: 482133
          minimum: 1
          maximum: 52428800
        contentType:
          $ref: '#/components/schemas/contentType'
        signedUrl:
          type: string
          description: >-
            Time-limited download URL (1 hour). Present on ticket detail
            responses.
      required:
        - path
        - name
        - size
        - contentType
    Model290:
      type: object
      properties:
        id:
          type: string
          example: 7d5c2f4e-9a1b-4c3d-8e2f-6a5b4c3d2e1f
          x-format:
            guid: true
        authorType:
          $ref: '#/components/schemas/authorType'
        authorId:
          type: string
        authorName:
          type: string
          example: ops@yourfirm.com
        body:
          type: string
          example: We shipped a fix — can you confirm it looks right now?
        attachments:
          $ref: '#/components/schemas/attachments'
        createdAt:
          type: string
          example: '2026-08-27T16:21:00.000Z'
          x-format:
            isoDate: true
    authorType:
      type: string
      description: >-
        "firm" — written by your team; "hyperprop" — a reply from Hyperprop
        support
      example: hyperprop
      enum:
        - firm
        - hyperprop
  securitySchemes:
    Bearer:
      type: apiKey
      name: Authorization
      in: header
      description: >-
        JWT Bearer token for user session auth. Format: "Bearer {token}". Used
        by User and Organization endpoints.
    X-API-Key:
      type: apiKey
      name: X-API-Key
      in: header
      description: >-
        Organization API key for programmatic access. Format: "hp_live_{key}".
        Used by Organization endpoints as an alternative to Bearer token. Keys
        are managed in the dashboard.

````

## Related topics

- [Reply on a support ticket](/platform-api/organization/reply-on-a-support-ticket.md)
- [List your support tickets](/platform-api/organization/list-your-support-tickets.md)
- [Get a support ticket with its reply thread](/platform-api/organization/get-a-support-ticket-with-its-reply-thread.md)
- [Get signed upload URLs for ticket attachments](/platform-api/organization/get-signed-upload-urls-for-ticket-attachments.md)
- [Changelog](/changelog.md)
