Skip to main content
POST
Update a portfolio's details.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Body

Current Name, replacement NewName and NewDescription, and IsActive. No action-specific non-empty or length validation is declared.

Current group name and replacement name, description, and active state; the endpoint determines whether the group is a book or portfolio.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Portfolios.ApiUpdateGroupDetailsRequest, Derivitec.Web.Core
portfolio_type
enum<string> | null

Portfolio category used to resolve the requested portfolio. It may be omitted when the portfolio name resolves unambiguously.

Available options:
derivitec,
enfusion,
orchestrade,
liquidity_book,
maia,
fund_studio,
not_set
name
string | null

Current name used to identify the book or portfolio being updated; the endpoint determines the group kind.

Example:

"Example group"

new_name
string | null

Replacement client-visible name for the selected group.

new_description
string | null

Replacement client-visible description for the selected group.

is_active
boolean

Replacement group state: true activates and false deactivates.

Response

Returns whether the portfolio changed, or unavailable-portfolio and non-owner errors.

Outcome of updating the display details and active state of the selected book or portfolio.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Portfolios.ApiUpdateGroupDetailsResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.