Skip to main content
POST
Set the active/inactive status of a batch of portfolios in a single call

Authorizations

Authorization
string
header
required

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

Body

A Names collection with at least one non-blank portfolio name after filtering and IsActive for the target state. Any supplied GroupType does not change the target portfolio type.

Book or portfolio names and a shared active state requested for a batch status change; the endpoint determines the group kind.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Portfolios.ApiBatchUpdateGroupStatusRequest, 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
names
string[] | null

Group names to update; blank values are ignored, duplicates are collapsed, and at least one usable name is required; the endpoint determines whether they identify books or portfolios.

is_active
boolean

Shared target state for every usable group name: true activates and false deactivates.

Response

Returns updated and failed names, including errors for an empty usable set or partial failure.

Book or portfolio names changed and names not changed by a batch status request.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Portfolios.ApiBatchUpdateGroupStatusResponse, 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.

updated_names
string[] | null

Requested book or portfolio names whose active state was changed.

failed_names
string[] | null

Requested book or portfolio names that were not changed, allowing partial success to be identified.