Skip to main content
PATCH
Change a portfolio's name, description, active scenario or Allow shorts

Authorizations

x-api-key
string
header
required

Raw API key shown once when created in the Allocait app (Settings > API keys). Send it verbatim in this header; the server stores and compares only its SHA-256 hash. Allocait generates every key: alc_ followed by 64 lowercase hex characters. Keys issued before 2026-10-10 are 64 hex characters with no prefix and keep working. A key may carry an expiry (90 days or 1 year, or never). A malformed, unknown, revoked or expired key gets 401 with no further detail, and a malformed one is refused before any lookup. Keys cannot be created through this API.

Path Parameters

id
string<uuid>
required

portfolio_id

Body

application/json
name
string
Maximum string length: 100
description
string | null
active_scenario_id
string<uuid>

A scenario you own, from GET /scenarios.

allow_shorts
boolean

Whether holdings may go short. Left out keeps the stored value; false is refused with IN_USE while a short is held.

Response

The portfolio was updated

success
boolean
portfolio
object

The full portfolio record, as returned by create/rename (a superset of PortfolioSummary's fields).