Skip to main content
POST
Add books to portfolios and optionally share them.

Authorizations

Authorization
string
header
required

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

Body

JSON request with non-null CreateBookRequests. Each item has a Name and Description of 2–100 characters, non-null ParentPortfolioNames, and non-null SharedUsers (which may be empty). A shared-user value must contain @.

Batch of books created item by item, allowing earlier successful items to remain when another item fails.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Positions.ApiCreateBooksRequest, Derivitec.Web.Core
create_book_requests
object[] | null

Book definitions, parent links, and sharing requests to process in order.

Response

Created

Common operation outcome containing a success indicator and any error messages.

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