> ## Documentation Index
> Fetch the complete documentation index at: https://docs.activeviam.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Add a book to a portfolio.

> Links one accessible Derivitec book beneath one portfolio. The caller needs `Edit` or `Owner`
access to the portfolio. Despite the plural route segment, the body links one book and one portfolio, and
the relationship is created before returning.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/Books/AddBookToPortfolios
openapi: 3.0.4
info:
  title: Derivitec Api 1.0
  version: '1.0'
servers:
  - url: https://api.riskportal.activeviam.com
security:
  - oauth2: []
  - apikey: []
tags:
  - name: AdminUser
  - name: AtotiReport
  - name: AtotiSession
  - name: BloombergOAuth
  - name: Bond
  - name: BondYieldCurvePage
  - name: BookAccess
  - name: Books
  - name: Commodity
  - name: Counterparties
  - name: Currencies
  - name: Equity
  - name: EquityDividend
  - name: EquityPage
  - name: FeatureFlag
  - name: Fx
  - name: FxPage
  - name: GroupAccess
  - name: Home
  - name: LegacyPosition
  - name: MarketData
  - name: MarketDataProvider
  - name: MarketDataProviderAccess
  - name: Meta
  - name: Notification
  - name: Organisation
  - name: PnLReport
  - name: PortfolioAccess
  - name: Portfolios
  - name: Position
  - name: PositionFilter
  - name: PricingEnvironment
  - name: PricingEnvironmentAccess
  - name: RateAsset
  - name: RateAssetPage
  - name: Report
  - name: ReportDefinition
  - name: ReportHistoryLauncherQuery
  - name: ReportLauncher
  - name: ReportQuery
  - name: ReportQueryViewUser
  - name: ReportRestriction
  - name: ReportView
  - name: RiskReport
  - name: Tradable
  - name: TradeBooking
  - name: User
  - name: VarReport
  - name: VarReportQuery
  - name: YieldCurvePage
paths:
  /api/Books/AddBookToPortfolios:
    post:
      tags:
        - Books
      summary: Add a book to a portfolio.
      description: >-
        Links one accessible Derivitec book beneath one portfolio. The caller
        needs `Edit` or `Owner`

        access to the portfolio. Despite the plural route segment, the body
        links one book and one portfolio, and

        the relationship is created before returning.
      operationId: AddBookToPortfolio
      requestBody:
        description: >-
          Required `PortfolioName` and `BookName`. `PortfolioType` may be
          omitted only when that name is unambiguous across the caller's
          available portfolio types; otherwise select an available
          `PortfolioType`.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiLinkBookToPortfolioAddRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiLinkBookToPortfolioAddRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiLinkBookToPortfolioAddRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiLinkBookToPortfolioAddRequest'
      responses:
        '200':
          description: >-
            Returns whether the relationship was added, or name, type, or access
            errors.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiLinkBookToPortfolioAddResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiLinkBookToPortfolioAddRequest:
      required:
        - $type
      type: object
      additionalProperties: false
      description: >-
        Book and portfolio selection for adding a direct book-to-portfolio
        relationship.
      properties:
        book_name:
          type: string
          description: Name of the book to select for the chosen portfolio.
          nullable: true
          example: Example book
        portfolio_name:
          type: string
          description: >-
            Name of the portfolio to select. The value must not be null or
            empty.
          nullable: true
          example: Example portfolio
        portfolio_type:
          enum:
            - derivitec
            - enfusion
            - orchestrade
            - liquidity_book
            - maia
            - fund_studio
            - not_set
          type: string
          description: >-
            Portfolio category used to resolve the requested portfolio. It may
            be omitted when the portfolio name resolves unambiguously.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.Book.ApiLinkBookToPortfolioAddRequest,
              Derivitec.Web.Core
    ApiLinkBookToPortfolioAddResponse:
      required:
        - $type
      type: object
      additionalProperties: false
      description: Outcome of adding a book to a portfolio.
      properties:
        is_success:
          type: boolean
          description: >-
            Whether the operation completed successfully. The default is `true`;
            error outcomes set it to `false`.
          example: true
        error_messages:
          type: array
          items:
            type: string
          description: >-
            Messages explaining operation-level failures. The collection is
            empty by default.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.Book.ApiLinkBookToPortfolioAddResponse,
              Derivitec.Web.Core
  securitySchemes:
    oauth2:
      type: oauth2
      description: >-
        OAuth2 access-token requested from AWS Cognito and provided as a Auth
        Bearer header
      flows:
        implicit:
          authorizationUrl: https://auth.riskportal.derivitec.com/oauth2/authorize
          scopes: {}
    apikey:
      type: apiKey
      description: API-Key requested via the site and provided as a header
      name: x-api-key
      in: header

````