Skip to main content
POST
TypeScript

Authorizations

Authorization
string
header
required

The Venue key (trdrs_vk_sandbox_… or trdrs_vk_production_…), in preview. It belongs to one venue in one environment and carries the scopes it was created with. The venue's verified owner creates it while signed in, and it works only on the /api/partner/venues/{venueId} routes. A trdrs_sk_… key can't be used in its place. It never lets you act as a trader, sign in or manage keys. Keep it on your server.

Headers

Idempotency-Key
string
required

A key you choose, 1 to 128 characters, that identifies this write. Send the same key when you retry it, so the write is never applied twice.

Required string length: 1 - 128

Path Parameters

venueId
string<uuid>
required
companyId
string<uuid>
required

Body

application/json
profile
object
required
expectedVersion
integer
required
Required range: x >= 1

Response

Success. The response is sent with Cache-Control: no-store, so don't cache it.

company
object
required

A company on trdrs, with the roles it plays: traders connect their own accounts through it (connectsTraders), a venue can plug it in as a provider (pluggable), or it runs a venue (runsVenue). Where the company appears follows from those roles. Each of the six built-in providers is a company with builtInProvider set, and a company holds its brand and listing state.

profile
object
required