Update a book's details.
Use this operation as the owner of a Derivitec book to rename it, replace its description, and set its
active state. Supplied values are applied together before returning. Any supplied GroupType does not
change the target book type.
Authorizations
OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header
Body
Current accessible Name, replacement NewName and NewDescription, and IsActive. The current contract has no action-specific non-empty or length validation for replacement strings.
Current group name and replacement name, description, and active state; the endpoint determines whether the group is a book or portfolio.
Derivitec.Web.Core.Portfolios.ApiUpdateGroupDetailsRequest, Derivitec.Web.Core Portfolio category used to resolve the requested portfolio. It may be omitted when the portfolio name resolves unambiguously.
derivitec, enfusion, orchestrade, liquidity_book, maia, fund_studio, not_set Current name used to identify the book or portfolio being updated; the endpoint determines the group kind.
"Example group"
Replacement client-visible name for the selected group.
Replacement client-visible description for the selected group.
Replacement group state: true activates and false deactivates.
Response
Returns whether the book changed, or ownership and unavailable-book errors in the response envelope.
Outcome of updating the display details and active state of the selected book or portfolio.
Derivitec.Web.Core.Portfolios.ApiUpdateGroupDetailsResponse, Derivitec.Web.Core Whether the operation completed successfully. The default is true; error outcomes set it to false.
true
Messages explaining operation-level failures. The collection is empty by default.