Skip to main content
POST
Submit intent

Authorizations

x-api-key
string
header
required

Body

application/json

Intent command to append, together with the trading_account_id that should execute it. Create starts a new intent lineage; replace and cancel append to the lineage referenced by the command payload's ref_intent_id. The top-level client_reference_id is accepted for caller correlation but is not currently persisted on newly created action records.

command
object
required

Requested intent operation and its payload.

trading_account_id
string<uuid>
required

Trading account that should execute the intent.

Carried in the body rather than the path: submission is a command against the caller's organization, and the account it targets is part of the command.

client_reference_id
string | null

Optional caller-provided correlation ID for downstream reconciliation.

Response

Intent accepted

intent_id
string<uuid>
required