Skip to main content
PATCH
Update a trading plan

Authorizations

X-API-Key
string
header
required

Organization API key (hp_live_...), sent in the X-API-Key header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A full-access key can call every endpoint in this reference. A read-only key can call GET endpoints (and create a trading stream token); any other request returns 403 READ_ONLY_KEY. A key with an IP allowlist returns 403 IP_NOT_ALLOWED from any other address. Each endpoint lists which keys can call it under Access.

Headers

Idempotency-Key
string

Optional. A value that identifies this operation on your side, at most 255 characters. A retry with the same key, method, path and body within 24 hours returns the original response (with Idempotency-Replayed: true) instead of repeating the change. The same key with a different body returns 409 IDEMPOTENCY_KEY_REUSED; a retry while the first request is still running returns 409 IDEMPOTENCY_KEY_IN_PROGRESS. A response that contains a credential (such as a new API key or signing secret) is not saved: the change is still not repeated, and a retry returns 409 IDEMPOTENCY_KEY_COMPLETED with the original status in originalStatus. Server errors (5xx) are not saved, so a retry runs again. If the key cannot be recorded, the request is not run and returns 503 IDEMPOTENCY_UNAVAILABLE; retry with the same key.

Maximum string length: 255

Path Parameters

planId
string
required

The plan ID to update

Body

application/json
name
string

New plan name (must be unique)

Maximum string length: 200
Example:

"Updated Plan Name"

displayName
string

Customer-facing plan name shown to traders in the trading app, up to 120 characters. When null, traders see the plan name. Send null or an empty string to clear it.

Maximum string length: 120
Example:

"100K Evaluation"

description
string

New description (null to clear)

Maximum string length: 2000
Example:

"Updated description"

price
number

New price

Required range: 0 <= x <= 100000000
Example:

349

currency
string

New currency code

Example:

"EUR"

durationDays
number

New duration (null = unlimited)

Example:

45

accountSize
number

New account size

Required range: 0 <= x <= 100000000
Example:

150000

tradingRuleId
string

New trading rule ID

isActive
boolean

Enable/disable plan

metadata
object

New metadata. Replaces existing metadata wholesale unless mergeMetadata is true. At most 16 KB as JSON, 50 top-level keys and 5 levels of nesting; larger metadata returns 400 METADATA_TOO_LARGE.

Example:
markets
enum<string>[]

Markets accounts on this plan trade. Any CME Group exchange grants the full CME, CBOT, NYMEX and COMEX bundle; BINANCE adds crypto perpetuals, HYPERLIQUID adds index and commodity perpetuals and HDL adds Hyperprop Deep Liquidity crypto perpetuals (one book consolidated from several exchanges). Accounts created without their own markets use these; a plan that sets none uses the CME Group bundle. Every organization is enabled for the CME Group bundle. Perpetuals (BINANCE, HYPERLIQUID, HDL) must each be enabled for your organization by Hyperprop; until then, a request that includes one is refused with 403 MARKET_NOT_ALLOWED. Send null to return to the CME Group bundle. Existing accounts keep their markets.

Minimum array length: 1
Available options:
CME,
CBOT,
NYMEX,
COMEX,
BINANCE,
HYPERLIQUID,
HDL
Example:
mergeMetadata
boolean

When true, the provided metadata keys are merged into the existing metadata instead of replacing it entirely

Example:

true

Response

Plan updated successfully

success
boolean
Example:

true

message
string
Example:

"Trading plan updated successfully"

data
object