# Capital.com API PUT /api/v1/workingorders/{dealId}

Independent and unofficial. Not affiliated with or endorsed by any broker or platform named here. Educational only: nothing here is advice, and nothing here recommends a broker or a trade.

This is the markdown version of https://openbrokerapi.com/brokers/capital-com/endpoints/put-working-order, written from the same records as that page.

Risk warning: CFDs and spread bets are complex instruments and come with a high risk of losing money rapidly due to leverage. You can lose money on these products, and each provider publishes its own loss figure under FCA rules. You should consider whether you understand how they work and whether you can afford to take the high risk of losing your money. Automated and API trading can amplify losses through bugs, connectivity failures and runaway orders.

Amend a LIMIT or STOP working order: its price level, cancellation date, stop loss or take profit.

- Request: `PUT /api/v1/workingorders/{dealId}`
- Version: v1
- Group: Working orders
- Status: verified. Source: [open-api.capital.com](https://open-api.capital.com/), checked 2026-10-12.
- Official reference: https://open-api.capital.com/

Note: Listed as Update working order in Capital.com's official Postman collection (opened on the date shown), with its body parameters and examples. The reference at open-api.capital.com documents this call too, with the same body fields, each marked as not required. Method, path and request parameters were re-read on open-api.capital.com on 12 Oct 2026 and agree with this record; the mock reply was not compared field by field.

## Parameters

- `dealId` (in path, type string, required): Permanent deal ID of the working order to amend. Mock value shown.
- `level` (in body, type number, optional): Order price.
- `goodTillDate` (in body, type string, optional): Cancellation date in UTC, format YYYY-MM-DDTHH:MM:SS. Leave out for good till cancelled.
- `guaranteedStop` (in body, type boolean, optional): True for a guaranteed stop. Then set stopLevel, stopDistance or stopAmount. Not allowed with trailingStop or in hedging mode.
- `trailingStop` (in body, type boolean, optional): True for a trailing stop. Then set stopDistance. Not allowed with guaranteedStop.
- `stopLevel` (in body, type number, optional): Price at which the stop loss triggers.
- `stopDistance` (in body, type number, optional): Distance from the current price to the stop loss. Required when trailingStop is true.
- `stopAmount` (in body, type number, optional): Loss amount at which the stop loss triggers.
- `profitLevel` (in body, type number, optional): Price at which the take profit triggers.
- `profitDistance` (in body, type number, optional): Distance from the current price to the take profit.
- `profitAmount` (in body, type number, optional): Profit amount at which the take profit triggers.

### Authentication headers

- `CST` (type string, required): Access token returned in the CST response header of POST /session. Valid for 10 minutes after last use. Placeholder only.
- `X-SECURITY-TOKEN` (type string, required): Account token returned in the X-SECURITY-TOKEN response header of POST /session. It selects the financial account. Placeholder only.

## Request

Written from the method, path and parameters recorded on this page, against the demo host. Not executed against a live or demo account. Credentials are read from environment variables on your own machine and are never entered on this site. The request builder at https://openbrokerapi.com/tools/request-builder writes these same snippets, from the same record.

This call takes a request body. The record marks no body field as required, so the samples send an empty JSON object with a Content-Type of application/json. Add the fields the call needs from the parameters above before the request can succeed.

### Python

```python
# Set CAPITAL_CST, CAPITAL_SECURITY_TOKEN as environment variables first. Never paste real values into code.
# CAPITAL_CST and CAPITAL_SECURITY_TOKEN hold the CST and X-SECURITY-TOKEN headers that POST /api/v1/session returns: step 3 of the quickstart (/brokers/capital-com/quickstart#step-3) captures them and this sample reads them back.
# Replace each {placeholder}, "..." and 0 with a real value before running.
# Optional and not shown: body fields level, goodTillDate, guaranteedStop, trailingStop, stopLevel, stopDistance, stopAmount, profitLevel, profitDistance, profitAmount.
import os
import requests

BASE_URL = "https://demo-api-capital.backend-capital.com"  # the demo host
headers = {
    "CST": os.environ["CAPITAL_CST"],
    "X-SECURITY-TOKEN": os.environ["CAPITAL_SECURITY_TOKEN"],
}
body = {}
resp = requests.put(BASE_URL + "/api/v1/workingorders/{dealId}", headers=headers, json=body, timeout=10)
resp.raise_for_status()
print(resp.json())
```

### JavaScript

```javascript
// Set CAPITAL_CST, CAPITAL_SECURITY_TOKEN as environment variables first. Never paste real values into code.
// CAPITAL_CST and CAPITAL_SECURITY_TOKEN hold the CST and X-SECURITY-TOKEN headers that POST /api/v1/session returns: step 3 of the quickstart (/brokers/capital-com/quickstart#step-3) captures them and this sample reads them back.
// Replace each {placeholder}, "..." and 0 with a real value before running.
// Optional and not shown: body fields level, goodTillDate, guaranteedStop, trailingStop, stopLevel, stopDistance, stopAmount, profitLevel, profitDistance, profitAmount.
// Run as a module, for example a .mjs file, on a Node version that has fetch built in.
const BASE_URL = "https://demo-api-capital.backend-capital.com"; // the demo host
const res = await fetch(BASE_URL + "/api/v1/workingorders/{dealId}", {
  method: "PUT",
  headers: {
    "CST": process.env.CAPITAL_CST,
    "X-SECURITY-TOKEN": process.env.CAPITAL_SECURITY_TOKEN,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());
```

### curl

```bash
# Set CAPITAL_CST, CAPITAL_SECURITY_TOKEN as environment variables first. Never paste real values into code.
# CAPITAL_CST and CAPITAL_SECURITY_TOKEN hold the CST and X-SECURITY-TOKEN headers that POST /api/v1/session returns: step 3 of the quickstart (/brokers/capital-com/quickstart#step-3) captures them and this sample reads them back.
# Replace each {placeholder}, "..." and 0 with a real value before running.
# Optional and not shown: body fields level, goodTillDate, guaranteedStop, trailingStop, stopLevel, stopDistance, stopAmount, profitLevel, profitDistance, profitAmount.
curl -X PUT "https://demo-api-capital.backend-capital.com/api/v1/workingorders/{dealId}" \
  -H "CST: $CAPITAL_CST" \
  -H "X-SECURITY-TOKEN: $CAPITAL_SECURITY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
```

## Response

A mock response. The values are invented, so check field names against the [official reference](https://open-api.capital.com/).

```json
{
  "_mock": true,
  "dealReference": "o_MOCK-REF-0002"
}
```

## Response schema, HTTP 200

Every field this site's OpenAPI file for Capital.com (https://openbrokerapi.com/specs/capital-com.json) declares for this response.

- `dealReference` (string): Not recorded

Status: unverified. No source opened. This schema is not sourced to a page of the provider's own that we opened, so check field names against the official reference.

## Limits that apply at Capital.com

- Headline limit: 10/s per user
  - Scope: user
  - Status: verified. Source: [open-api.capital.com](https://open-api.capital.com/), checked 2026-09-18.
  - Note: Orders and new positions: 1 per 0.1 s. POST /session: 1 a second per API key. Demo: 1000 an hour for POST /positions and /workingorders.

## More on the Capital.com API

- [All Capital.com API endpoints](https://openbrokerapi.com/brokers/capital-com/endpoints): 36 documented, grouped by what they do.
- [Capital.com API quickstart](https://openbrokerapi.com/brokers/capital-com/quickstart)
- [All Capital.com API error codes](https://openbrokerapi.com/errors/capital-com)
- [Capital.com API page](https://openbrokerapi.com/brokers/capital-com): The full record: access, authentication, limits and the source for each.
- [Capital.com API as an OpenAPI file](https://openbrokerapi.com/specs/capital-com.json): Generated from these endpoint records. Independent and unofficial.

## Licence and how to cite

The records behind this page are all rights reserved. This file is the page itself, at its own address, in another format. It is not part of the CC BY 4.0 downloads listed at https://openbrokerapi.com/data. Quote from it with a link to the page.

Cite as: Capital.com API PUT /api/v1/workingorders/{dealId}. Broker API Hub, https://openbrokerapi.com/brokers/capital-com/endpoints/put-working-order, newest check 2026-10-12.

Where you rely on a single figure, cite the source and the checked date printed beside it as well. Where this page and a broker's own documentation differ, the documentation wins.