Skip to main content
PUT
TypeScript

Authorizations

Authorization
string
header
required

Your firm’s API key (the API calls this the tenant key; trdrs_sk_…), server-to-server only.

Path Parameters

id
string
required

Body

application/json

Author or replace a plan. A replacement carries revision: the value the caller read. A revision that is not the stored one is refused with 409 rather than overwriting an edit nobody saw.

name
string
required
definition
object
required

WireExitPlanDefinition (@trdrs/contracts): the structured plan — everything the engine needs to resolve concrete legs, and nothing about an account, a venue or a price. unit says what the distances mean; price and currency are resolved to ticks by the engine against the account's own instrument facts. quantity is what the ladder was authored for: an order may carry more, and the surplus is an unmanaged remainder the plan never protects.

Example:
revision
string

Required on a replacement; ignored on a create.

applicability
object

Response

The plan as saved

plan
object
required

WireSavedExitPlan (@trdrs/contracts): one saved plan. revision is opaque — echo back exactly the value you read on a save or a delete, and never construct one. requires is what the plan needs an account to support, derived from the plan itself, so a host can tell which plans a selected account can run.

Example: