Skip to main content
POST
Create a portfolio.

Authorizations

Authorization
string
header
required

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

Body

Required non-empty PortfolioName and Description. This request declares no explicit API length bounds.

Name and description used to create a Derivitec-managed portfolio.

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

Name for the new portfolio; it must be non-empty and not duplicate a portfolio linked to the caller.

Example:

"Example portfolio"

description
string | null

Non-empty client-visible description for the new portfolio.

Response

Created

Outcome of creating a portfolio.

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