CLclear-street
Positions

Cancel Position Instruction

Changed on

Cancel an outstanding position instruction by its server-assigned id. Returns the updated instruction with status CANCEL_REQUESTED. The terminal CANCELLED or CANCEL_FAILED state arrives asynchronously and is observable via subsequent GETs.

delete/v1/accounts/{account_id}/positions/instructions/{instruction_id}

Request

  • Base URL
    https://api.clearstreet.com
  • Auth
    HTTP bearer

Path parameters

account_idinteger required

Account identifier

instruction_idstring uuid required

Server-assigned instruction id

Response

Cancel accepted

Example response

{
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero"
  },
  "metadata": {
    "page_number": 1,
    "total_items": 42,
    "total_pages": 5
  },
  "data": {
    "accepted_quantity": null,
    "account_id": 122503,
    "client_instruction_id": "ui-20260424-001",
    "created_at": "2026-04-24T14:30:00Z",
    "id": "0195f6d0-a1b2-7c3d-8e4f-5a6b7c8d9e02",
    "instruction_type": "EXERCISE",
    "instrument_id": "0195f6d0-a1b2-7c3d-8e4f-5a6b7c8d9e02",
    "quantity": "1",
    "rejection_reason": null,
    "status": "SENT",
    "symbol": "AAPL  280121C00195000",
    "updated_at": "2026-04-24T14:30:00Z"
  }
}

Changes

  • 1bd9eddeffc8Revision changes
    • breaking

      removed the required property // from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

  • 99644beba9d7Revision changes
    • info

      removed the ENGINE_REJECTED enum value from the // response property for the response status