Skip to main content
POST
Remove a book from a portfolio.

Authorizations

Authorization
string
header
required

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

Body

Required PortfolioName and BookName; provide PortfolioType when the portfolio name is ambiguous across available portfolio types.

Book and portfolio selection for removing a direct book-to-portfolio relationship.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Book.ApiLinkBookToPortfolioRemoveRequest, Derivitec.Web.Core
book_name
string | null

Name of the book to select for the chosen portfolio.

Example:

"Example book"

portfolio_name
string | null

Name of the portfolio to select. The value must not be null or empty.

Example:

"Example portfolio"

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

Response

Returns the normal removal envelope with name, type, or access errors.

Outcome of removing a book from a portfolio.

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