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

# Release a stuck idempotency key

> Frees an `Idempotency-Key` whose request never finished, so you can send the request again with the same key instead of waiting 24 hours for it to expire.

A key is stuck when a retry returns `409 IDEMPOTENCY_KEY_IN_PROGRESS` with `stale: true`, or when `GET /organization/idempotency-keys` shows `in_progress` with `stale: true`. That happens when a request stops before a response is recorded, for example during a service disruption.

**Check before you retry.** A stuck request may still have taken effect before it stopped. Confirm the result directly (for example list the trader's accounts, or look up the account you were updating) before sending the request again.

Only an in-progress key that has been in progress for more than 120 seconds can be released:

- A **completed** key is never released (`409 IDEMPOTENCY_KEY_COMPLETED`, with its stored `response`): the request took effect, and a retry with the key returns that response.
- A key in progress for less than 120 seconds may still be running (`409 IDEMPOTENCY_KEY_NOT_STALE`, with `releasableAt`).
- A key with nothing on record returns `404 IDEMPOTENCY_KEY_NOT_FOUND`: it is already free to use.

Release a key with the same API key (or the same signed-in member) that sent the request, and give the same `method` and `path`. Requires the permission the original endpoint needs.

```bash
curl -X POST "https://api.hyperprop.com/platform/v1/organization/idempotency-keys/release" \
  -H "X-API-Key: hp_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"key": "acme-order-20058745", "method": "POST", "path": "/platform/v1/organization/trading-accounts"}'
```



## OpenAPI

````yaml https://api.hyperprop.com/platform/openapi.json post /v1/organization/idempotency-keys/release
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: Trading accounts
    description: Create, update, and inspect trading accounts.
  - name: Traders
    description: Look up and update the traders in your organization.
  - name: Trading plans
    description: Define the plans you sell.
  - name: Trading rules
    description: Define how accounts are evaluated.
  - name: Lockouts
    description: Pause and resume trading on an account.
  - name: Payouts
    description: Check payout eligibility and record payouts.
  - name: Purchases
    description: Purchases recorded for your organization.
  - name: Time Machine
    description: Restore accounts to an earlier trading day or instant.
  - name: Webhooks
    description: Register webhook endpoints and inspect deliveries.
  - name: Events
    description: Your organization's event history and real-time event stream.
  - name: Reconciliation
    description: Balances, end-of-day snapshots, and fills for reconciliation.
  - name: Analytics
    description: Organization performance and plan economics.
  - name: Billing
    description: 'Your Hyperprop bill: activity, billing cycles, and forecasts.'
  - name: Team and roles
    description: Manage dashboard access for your staff.
  - name: API keys
    description: Manage your organization's API key.
  - name: Logs and health
    description: >-
      API request logs, the audit log, integration health, and idempotency key
      recovery.
  - name: Organization profile
    description: Your organization's profile and logo.
  - name: Support
    description: Open and follow up on support tickets.
  - name: Partner access
    description: >-
      Read a trader's journal as an approved partner app, with the trader's own
      key.
paths:
  /v1/organization/idempotency-keys/release:
    post:
      tags:
        - Logs and health
      summary: Release a stuck idempotency key
      description: >-
        Frees an `Idempotency-Key` whose request never finished, so you can send
        the request again with the same key instead of waiting 24 hours for it
        to expire.


        A key is stuck when a retry returns `409 IDEMPOTENCY_KEY_IN_PROGRESS`
        with `stale: true`, or when `GET /organization/idempotency-keys` shows
        `in_progress` with `stale: true`. That happens when a request stops
        before a response is recorded, for example during a service disruption.


        **Check before you retry.** A stuck request may still have taken effect
        before it stopped. Confirm the result directly (for example list the
        trader's accounts, or look up the account you were updating) before
        sending the request again.


        Only an in-progress key that has been in progress for more than 120
        seconds can be released:


        - A **completed** key is never released (`409
        IDEMPOTENCY_KEY_COMPLETED`, with its stored `response`): the request
        took effect, and a retry with the key returns that response.

        - A key in progress for less than 120 seconds may still be running (`409
        IDEMPOTENCY_KEY_NOT_STALE`, with `releasableAt`).

        - A key with nothing on record returns `404 IDEMPOTENCY_KEY_NOT_FOUND`:
        it is already free to use.


        Release a key with the same API key (or the same signed-in member) that
        sent the request, and give the same `method` and `path`. Requires the
        permission the original endpoint needs.


        ```bash

        curl -X POST
        "https://api.hyperprop.com/platform/v1/organization/idempotency-keys/release"
        \
          -H "X-API-Key: hp_live_your_key_here" \
          -H "Content-Type: application/json" \
          -d '{"key": "acme-order-20058745", "method": "POST", "path": "/platform/v1/organization/trading-accounts"}'
        ```
      operationId: postV1OrganizationIdempotencykeysRelease
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model938'
      responses:
        '200':
          description: Success - The key is released; send the request again with it
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model940'
        '400':
          description: >-
            Bad Request - Invalid query or body (`VALIDATION_ERROR`), or `path`
            is not an organization endpoint (`INVALID_PATH`)
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model131'
        '401':
          description: Authentication required
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model11'
        '403':
          description: >-
            Forbidden - Your role or API key lacks the permission the original
            endpoint needs
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model132'
        '404':
          description: >-
            Not Found - Nothing is on record for this key on this endpoint; it
            is free to use (`IDEMPOTENCY_KEY_NOT_FOUND`)
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model941'
        '409':
          description: >-
            Conflict - The request completed (`IDEMPOTENCY_KEY_COMPLETED`, with
            `response`) or may still be running (`IDEMPOTENCY_KEY_NOT_STALE`,
            with `releasableAt`); nothing was released
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model944'
        '500':
          description: An unexpected error occurred
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model6'
      security:
        - X-API-Key: []
components:
  schemas:
    Model938:
      type: object
      properties:
        key:
          type: string
          description: The `Idempotency-Key` value you sent
          example: acme-order-20058745
          minLength: 1
          maxLength: 255
        method:
          $ref: '#/components/schemas/method'
        path:
          type: string
          description: >-
            Path of the original request, as sent
            (`/platform/v1/organization/...`; a path starting at `/v1/` also
            works). No query string.
          example: /platform/v1/organization/trading-accounts
          minLength: 1
          maxLength: 500
      required:
        - key
        - path
    Model940:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model939'
    Model131:
      type: object
      properties:
        success:
          type: boolean
          example: false
        statusCode:
          type: number
          example: 400
        error:
          type: string
          example: Bad Request
        message:
          type: string
          example: >-
            `path` must be the organization endpoint the key was sent to, for
            example /platform/v1/organization/trading-accounts
        code:
          $ref: '#/components/schemas/Model130'
    Model11:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 401
        error:
          type: string
          example: Unauthorized
        message:
          type: string
          example: Authentication required
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: UNAUTHORIZED
    Model132:
      type: object
      properties:
        success:
          type: boolean
          example: false
        statusCode:
          type: number
          example: 403
        error:
          type: string
          example: Forbidden
        message:
          type: string
          example: Your role does not have write access to "Traders & accounts"
        code:
          type: string
          example: INSUFFICIENT_PERMISSIONS
    Model941:
      type: object
      properties:
        success:
          type: boolean
          example: false
        statusCode:
          type: number
          example: 404
        error:
          type: string
          example: Not Found
        message:
          type: string
          example: >-
            No request with this Idempotency-Key is on record for this endpoint;
            you can send the request with it
        code:
          type: string
          example: IDEMPOTENCY_KEY_NOT_FOUND
    Model944:
      type: object
      properties:
        success:
          type: boolean
          example: false
        statusCode:
          type: number
          example: 409
        error:
          type: string
          example: Conflict
        message:
          type: string
          example: >-
            The earlier request with this Idempotency-Key may still be running.
            It can be released from `releasableAt`.
        code:
          $ref: '#/components/schemas/Model942'
        startedAt:
          type: string
          example: '2026-10-21T13:37:10.000Z'
        releasableAt:
          type: string
          description: With IDEMPOTENCY_KEY_NOT_STALE
          example: '2026-10-21T13:39:10.000Z'
        response:
          $ref: '#/components/schemas/Model943'
    Model6:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 500
        error:
          type: string
          example: Internal Server Error
        message:
          type: string
          example: An unexpected error occurred
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: INTERNAL_ERROR
    method:
      type: string
      description: HTTP method of the original request
      example: POST
      default: POST
      enum:
        - POST
        - PUT
        - PATCH
        - DELETE
      x-convert:
        case: upper
    Model939:
      type: object
      properties:
        released:
          type: boolean
          example: true
        key:
          type: string
          example: acme-order-20058745
        method:
          type: string
          example: POST
        path:
          type: string
          example: /platform/v1/organization/trading-accounts
        startedAt:
          type: string
          description: When the stuck request arrived
          example: '2026-10-21T13:37:10.000Z'
    Model130:
      type: string
      example: INVALID_PATH
      enum:
        - VALIDATION_ERROR
        - INVALID_PATH
    Model942:
      type: string
      example: IDEMPOTENCY_KEY_NOT_STALE
      enum:
        - IDEMPOTENCY_KEY_COMPLETED
        - IDEMPOTENCY_KEY_NOT_STALE
    Model943:
      type: object
      description: 'With IDEMPOTENCY_KEY_COMPLETED: the stored outcome'
      properties:
        statusCode:
          type: integer
          example: 201
        body:
          type: string
  securitySchemes:
    X-API-Key:
      type: apiKey
      name: X-API-Key
      in: header
      description: >-
        Organization API key. Format: "hp_live_{key}". Organization admins
        manage the key in the dashboard.

````

## Related topics

- [Idempotency](https://docs.hyperprop.com/concepts/idempotency.md)
- [Look up an idempotency key](https://docs.hyperprop.com/platform-api/logs-and-health/look-up-an-idempotency-key.md)
- [Errors](https://docs.hyperprop.com/concepts/errors.md)
- [Changelog](https://docs.hyperprop.com/changelog.md)
- [Rebind a customer to a new Hyperprop login (support flow)](https://docs.hyperprop.com/platform-api/traders/rebind-a-customer-to-a-new-hyperprop-login-support-flow.md)


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