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

# Update active lockout

> Update the reason or end time of an active lockout without removing and recreating it.

**Use cases:**
- Extend a lockout that needs more review time
- Update the reason with additional context
- Shorten the lockout period after partial review

Changes take effect immediately.



## OpenAPI

````yaml /api-reference/openapi.json patch /v1/organization/lockouts/{accountId}
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, and integration health.
  - 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/lockouts/{accountId}:
    patch:
      tags:
        - Lockouts
      summary: Update active lockout
      description: >-
        Update the reason or end time of an active lockout without removing and
        recreating it.


        **Use cases:**

        - Extend a lockout that needs more review time

        - Update the reason with additional context

        - Shorten the lockout period after partial review


        Changes take effect immediately.
      operationId: patchV1OrganizationLockoutsAccountid
      parameters:
        - description: Account ID with active lockout
          x-format:
            guid: true
          name: accountId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model877'
      responses:
        '200':
          description: Lockout updated
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model879'
        '400':
          description: No fields to update
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model880'
        '401':
          description: Authentication required
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model9'
        '403':
          description: Access denied
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model47'
        '404':
          description: No active lockout found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model881'
        '500':
          description: An unexpected error occurred
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model5'
      security:
        - X-API-Key: []
components:
  schemas:
    Model877:
      type: object
      properties:
        reason:
          type: string
          description: Updated reason
          example: 'Extended: pending compliance review'
          minLength: 3
        endsAt:
          type: string
          description: Updated expiry time
          example: '2026-05-01T00:00:00Z'
          x-format:
            isoDate: true
    Model879:
      type: object
      properties:
        success:
          type: boolean
          example: true
        message:
          type: string
          example: Lockout updated successfully
        data:
          $ref: '#/components/schemas/Model878'
    Model880:
      type: object
      properties:
        statusCode:
          type: number
          example: 400
        error:
          type: string
          example: Bad Request
        message:
          type: string
          example: No fields to update. Provide reason or endsAt.
        code:
          type: string
          example: NO_FIELDS_TO_UPDATE
    Model9:
      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
    Model47:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 403
        error:
          type: string
          example: Forbidden
        message:
          type: string
          example: Access denied
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: FORBIDDEN
    Model881:
      type: object
      properties:
        statusCode:
          type: number
          example: 404
        error:
          type: string
          example: Not Found
        message:
          type: string
          example: No active lockout found for this account
        code:
          type: string
          example: NO_ACTIVE_LOCKOUT
    Model5:
      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
    Model878:
      type: object
      example:
        id: b1c2d3e4-f5a6-7890-abcd-ef1234567890
        accountId: 7c9e6679-7425-40de-944b-e07fc1f90ae7
        mode: admin
        reason: 'Extended: pending compliance review'
        lockedBy: admin
        startsAt: '2026-03-12T15:00:00.000Z'
        endsAt: '2026-05-01T00:00:00.000Z'
        createdAt: '2026-03-12T15:00:00.000Z'
      properties:
        id:
          type: string
        accountId:
          type: string
        mode:
          type: string
        reason:
          type: string
        lockedBy:
          type: string
        startsAt:
          type: string
        endsAt:
          type: string
        createdAt:
          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

- [Create or update account lockout](/trade-api/account/create-or-update-account-lockout.md)
- [List all active lockouts](/platform-api/lockouts/list-all-active-lockouts.md)
- [Update a webhook](/platform-api/webhooks/update-a-webhook.md)
- [Remove lockout from account](/platform-api/lockouts/remove-lockout-from-account.md)
- [Remove account lockout](/trade-api/account/remove-account-lockout.md)


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