Skip to main content
PATCH
cURL

Authorizations

X-Api-Key
string
header
required

Path Parameters

asset_class_uuid
string<uuid>
required
organization_uuid
string<uuid>
required

Body

Serializer for creating and updating AssetClass data. Requires exactly one universe definition.

name
string
Maximum string length: 255
description
string
default_direct_indexing_enabled
boolean

Initial direct-indexing setting for new model or composite allocations. Explicit overrides win; changing this default does not change existing allocations.

benchmark_index_identifier
string | null
index_uuid
string<uuid> | null
tilt_uuid
string<uuid> | null
single_security_tilt_asset_id
string | null

tilt_asset_id of a single ticker held at 100% by this asset class sleeve.

event_contract_tilt_asset_id
string | null

tilt_asset_id of an event contract targeted directly by this sleeve.

event_contract_side
  • yes - yes
  • no - no
Available options:
yes,
no
alternative_etf_tilt_asset_ids
string[] | null

List of alternative ETF tilt_asset_ids. Only used when asset_class has a benchmark_index (ETF).

asset_allocations
object[]

Child sleeve allocations for a composite sleeve. Inline child creation is not supported.

security_allocations
object[]

Response

200 - application/json

Serializer for reading AssetClass data.

uuid
string<uuid>
required
read-only
name
string
required
Maximum string length: 255
description
string
required
default_direct_indexing_enabled
boolean
required
read-only

Initial direct-indexing setting for new model or composite allocations. Explicit overrides win; changing this default does not change existing allocations.

benchmark_index_name
string | null
required
read-only
benchmark_index_identifier
string | null
required
read-only
benchmark_direct_indexing_supported
boolean | null
required
read-only

Whether the benchmark supports direct indexing; null when this sleeve has no benchmark index.

index_name
string | null
required
read-only
index_uuid
string<uuid> | null
required
read-only
tilt_name
string | null
required
read-only
tilt_uuid
string<uuid> | null
required
read-only
single_security_tilt_asset_id
string | null
required
read-only
single_security_symbol
string | null
required
read-only
event_contract_tilt_asset_id
string | null
required
read-only
event_contract_side
required
  • yes - Yes
  • no - No
Available options:
yes,
no
alternative_etf_tilt_asset_ids
string[]
required
read-only

Return list of alternative ETF tilt_asset_ids.

is_private
boolean
required
read-only

Whether this is one account's in-place edit of a model sleeve, which firm lists never show.

is_model
boolean
required
read-only

Whether this sleeve is designated as a model.

model_uuid
string<uuid> | null
required
read-only

The designated model's UUID, for reading its settings and History; null for other sleeves.

is_composite
boolean
required
read-only

Whether this sleeve contains child sleeve allocations.

is_security_basket
boolean
required
read-only
security_allocations
object[]
required
read-only
asset_allocations
object[]
required
read-only
archived_at
string<date-time> | null
required
read-only

Archived sleeves remain resolvable by existing references but cannot be newly assigned.

created
string<date-time>
required
read-only

When the sleeve record was created. For model compositions created by migration this is conversion time, not the original model's creation time. Earlier model History may exist under model_uuid.

modified
string<date-time>
required
read-only