Skip to navigation

Delete a trading policy

Proposes deleting the policy for good (trading-policies:propose); /approve concludes it.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idintegerRequired

The record’s id — a positive 32-bit integer the platform minted.

Headers

Idempotency-KeystringRequired

Required on every write: a URL-safe string of 1 to 64 characters from [A-Za-z0-9._~-] (a UUID fits), scoped to you. It names one operation on one record, ever: a retry replays the stored outcome (Idempotent-Replay: true) or attaches to the live one, and reuse on another record refuses 409 IDEMPOTENCY_KEY_REUSED. Missing or malformed, 400.

If-MatchstringRequired

Required on every entity write: the ETag the read minted, quoted or bare — the version this write was computed against — or * to write unconditionally on purpose, except on a notification endpoint’s approval, which refuses * 400 INVALID_IF_MATCH. Absent is 428 PRECONDITION_REQUIRED; a weak validator 400 INVALID_IF_MATCH; a stale value 412 VERSION_CONFLICT (CONFIG_SEQ_CONFLICT on an algo’s config write) with currentVersion and a fresh ETag: re-read, reapply, retry. A * write overwrites every field from your copy, a colleague’s amend since your read included.

X-Request-IdstringOptional

Your own id for the request: 8 to 128 of [A-Za-z0-9._-]. It becomes the request’s id and is echoed on the response. A value off that grammar is replaced with a fresh id, never refused.

Query parameters

minGlobalSequencestringOptionalformat: "^[0-9]{1,19}$"

A position you hold — an X-Immix-Global-Sequence you read, or a 202’s commandGlobalSequence: this member answers only once it has folded the platform’s stream through it, waiting up to its deadline, then 503 PROJECTION_BEHIND with Retry-After. Within that stream a read is never older than what you have seen; drop your positions after an announced stream cut. A retry stating its 202’s position attaches to or replays that operation while the journal holds its key, never publishing twice. Stated once: one to nineteen digits, at most 9223372036854775807; else 400 MALFORMED_REQUEST.

Request

This endpoint expects an object.
tradingPolicyIdintegerOptional
expectedVersionstring or nullOptionalformat: "^-?[0-9]+$"
int64 as a decimal JSON string
remarkstringOptional

A note for the approvers of this proposal; empty-not-null. At most 256 bytes; longer refuses INVALID_FIELD. Optional in this body: absent reads as "".

Response

The trading policy as the platform now holds it after the write — the same row the read serves, with the answering change’s position, the row’s ETag and, on a replayed key, Idempotent-Replay.

approvalslist of objects

Who approved the row’s last proposal and when, in approval order — grown by each approval and kept on the concluded row as its record until the next proposal or a withdrawal clears it; empty until the first approval. The proposal concludes at the approval that meets the organisation’s count for the family as it stands then; pendingTransition says whether one is pending. a repeating group served as an array of objects, in the group’s own order; empty = no entries, never null

concludedTransitionenum

What the row’s last proposal proposed, kept once it concluded: the pending transition the conclusion cleared, as the register wrote it; NONE while it pends, or where none was. So the concluded row says what concluded, however its status has moved on since. NONE is the unset sentinel: outputs only — as input the field is required, and explicit NONE refuses 400. A consumer READING this field treats an unknown name as NONE, never as an error; as input an unknown name refuses 400 — the parse is strict

globalSequencestringformat: "^[0-9]+$"

The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included.

lastWithdrawalReasonstring

Why the last proposal was withdrawn, as the withdrawer stated it; empty-not-null.

orgIdinteger

Owner-stamped.

pendingTransitionenum

ACTIVATE, AMEND, DELETE or RESUME_TRADING; NONE otherwise. NONE is the unset sentinel: outputs only — as input the field is required, and explicit NONE refuses 400. A consumer READING this field treats an unknown name as NONE, never as an error; as input an unknown name refuses 400 — the parse is strict

remarkstring

The maker’s note on the pending proposal, for its approvers; empty-not-null. At most 256 bytes; longer refuses INVALID_FIELD.

statusenum

UNKNOWN is the unset sentinel: outputs only — as input the field is required, and explicit UNKNOWN refuses 400. A consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict

Allowed values:
tradingPolicyIdinteger
Sticky entity key.
versionstringformat: "^-?[0-9]+$"

The row’s version — monotonic per record, bumped on every change; orders record which version governed them. int64 as a decimal JSON string

concludedAtNsstring or nullOptionalformat: "^-?[0-9]+$"

Platform time the row’s last proposal concluded; 0 while it is pending, or when the row never carried one. A write the organisation’s count let through at once concludes in the maker’s own fact: equal to proposedAtNs. int64 as a decimal JSON string

concludedByobject or nullOptional

Who concluded the row’s last proposal: the approver whose approval met the organisation’s count, or the maker when the count was 0 and the write concluded at once; null while it is pending, or when the row never carried one. an actor: an object {kind, id}; null where none is stated

degradedGraceNsstring or nullOptionalformat: "^-?[0-9]+$"

The admission tolerance for a degraded connection: an order-entry credential whose connection has been DEGRADED for no longer than this still admits; DOWN always refuses, and a cancel never gates. 0 = any DEGRADED refuses (the strict reading). Measured from the health fact’s envelope time, so every member agrees. int64 as a decimal JSON string

instructFreshnessNsstring or nullOptionalformat: "^-?[0-9]+$"

How stale an accepted but never instructed order may be when it reaches the venue: past it the connector never places it and the order disposes toward INSTRUCTION_EXPIRED. 0 = the connector’s configured default window, never a lockout. int64 as a decimal JSON string

instrumentIdstring or nullOptionalformat: "^-?[0-9]+$"

The refdata instrument — carried, not resolved here; 0 on the wire, null in the API, on the organisation-wide default row. int64 as a decimal JSON string

isTradingHaltedbooleanOptional

The halt: true on the organisation-wide default row halts the organisation; true on a per-instrument row halts that instrument. False is the decode default — but no order is admitted without an ACTIVE policy row at all: the real gate is the row’s existence. a boolean; absent reads false

keyHolderobject or nullOptional

When an API key made the row’s last proposal, the member the key’s secret had last been answered to as it proposed — its last rotator then, else its issuer — kept on the concluded row with proposedBy; null when a member made the proposal, or the row never carried one. The proposal counts as this member’s and the key’s issuer’s, whoever rotates the key afterwards: neither may approve it (SELF_APPROVAL). an actor: an object {kind, id}; null where none is stated

lastWithdrawalAtNsstring or nullOptionalformat: "^-?[0-9]+$"

Platform time of that withdrawal; 0 when none was. The three fields and lastWithdrawalReason stand until the next proposal replaces them. int64 as a decimal JSON string

lastWithdrawalProposedByobject or nullOptional

Who made the last proposal that was withdrawn; null when none was. an actor: an object {kind, id}; null where none is stated

lastWithdrawalWithdrawnByobject or nullOptional

Who withdrew it — the proposer, or a checker returning it; null when none was. an actor: an object {kind, id}; null where none is stated

maxOpenOrdersinteger or nullOptional

Open-order ceiling; 0 = none. Counted over the organisation’s open orders as a whole: the tighter of the governing row’s and the organisation-wide default row’s stated ceilings binds. A per-instrument row’s ceiling is not yet scoped to its instrument.

maxOrderNotionalstring or nullOptionalformat: "^-?[0-9]+(\.[0-9]+)?$"<=64 characters

Per-order notional cap; 0 = no cap; refused non-zero on org-default rows as maxOrderQty. money (a Decimal on the wire: a scaled integer with its own scale), served as an exact decimal string at the value’s own scale — every fractional digit that scale states, trailing zeros included; never raw; null when the 0 sentinel means unset

maxOrderQtystring or nullOptionalformat: "^-?[0-9]+(\.[0-9]+)?$"<=64 characters

Per-order quantity cap; 0 = no cap. The organisation-wide default row has no scale context — a non-zero value on it is refused INVALID_FIELD. money (a Decimal on the wire: a scaled integer with its own scale), served as an exact decimal string at the value’s own scale — every fractional digit that scale states, trailing zeros included; never raw; null when the 0 sentinel means unset

maxOrdersPerMinuteinteger or nullOptional

Entry-rate ceiling per tumbling minute of stream time, enforced at the orders owner; 0 = no ceiling. Counted over the organisation’s accepted orders in the minute: the tighter of the governing row’s and the organisation-wide default row’s stated ceilings binds, as maxOpenOrders does.

priceCollarBpsinteger or nullOptional

The limit-price collar against the market-data top-of-book reference; 0 = no collar — the reference-freshness gate still applies unconditionally, since the reference is mandatory.

proposedAtNsstring or nullOptionalformat: "^-?[0-9]+$"

Platform time the row’s last proposal was made, kept on the concluded row; 0 when the row never carried one. int64 as a decimal JSON string

proposedByobject or nullOptional

Who made the row’s last proposal — kept on the concluded row as its record; null when the row never carried one (a row a connector or the platform landed). pendingTransition says whether that proposal is still pending. an actor: an object {kind, id}; null where none is stated

refFreshnessNsstring or nullOptionalformat: "^-?[0-9]+$"

How fresh the top-of-book reference must be at admission (the NO_REFERENCE_PRICE gate); 0 disables the age comparison alone — the reference itself stays mandatory for every order type, so an absent reference refuses either way. int64 as a decimal JSON string

Errors

400
Delete Trading Policies Request Bad Request Error
401
Delete Trading Policies Request Unauthorized Error
403
Delete Trading Policies Request Forbidden Error
404
Delete Trading Policies Request Not Found Error
409
Delete Trading Policies Request Conflict Error
412
Delete Trading Policies Request Precondition Failed Error
413
Delete Trading Policies Request Content Too Large Error
422
Delete Trading Policies Request Unprocessable Entity Error
428
Delete Trading Policies Request Precondition Error
429
Delete Trading Policies Request Too Many Requests Error
500
Delete Trading Policies Request Internal Server Error
503
Delete Trading Policies Request Service Unavailable Error