1. AllocationModels
Navexa API
  • Start your Navexa journey
  • Authentication
  • Navexa MCP
  • Reports
    • Get ATO myTax report
      GET
    • Get ATO myTax report PDF
      GET
    • Get Capital Gains Tax report
      GET
    • Get Taxable Income report
      GET
    • Get Unrealised Capital Gains Tax report
      GET
  • Benchmark
    • Get the benchmark return for a portfolio
      GET
  • CashAccount
    • Get Cash Account
      GET
    • Delete a Cash Account
      DELETE
    • Get all Cash Accounts
      GET
    • Create a Cash Account
      POST
    • Update a Cash Account
      PUT
    • Get Cash Account Transactions
      GET
  • CashAccountTransactions
    • Get a Cash Account Transaction
      GET
    • Delete a Cash Account Transaction
      DELETE
    • Create a Cash Account Transaction
      POST
    • Update a Cash Account Transaction
      PUT
  • Clients
    • Get all Clients
    • Create a client
    • Gets Client
    • Update a client
    • Delete client
    • Get client Portfolios
    • Assign portfolios to client
  • Holdings
    • Get a holding
    • Update a holding
    • Delete a holding
    • Get a holding's trades
    • Get holding income records
    • Update a holding's symbol and exchange
  • PortfolioPerformance
    • Get portfolio performance
  • Portfolios
    • Get all portfolios
    • Create a portfolio
    • Get a portfolio
    • Update a portfolio
    • Delete a portfolio
    • Get all portfolio holdings
  • ProRataDistributions
    • Update ETF Distributions ProRata
  • StocksIncome
    • Get an income record
    • Update Income record
    • Confirm Income record
  • TaxSettings
    • Get all portfolio tax settings
    • Get portfolio tax setting
    • Update portfolio tax settings
  • Trades
    • Get a trade
    • Delete a trade
    • Add a trade
  • CustomInvestmentPrice
    • Add a Price
    • Update a Price
    • Get a Price
    • Delete a Price
    • Bulk Add Prices
    • List Prices
  • SimulateSell
    • Get the assessable capital gain for a simulated sell trade
  • Sources
    • Get all sources
  • HoldingTimeseries
    • Get holding timeseries
  • PortfolioTimeseries
    • Get portfolio timeseries
  • PortfolioTransactions
    • Get portfolio transactions
  • AllocationModels
    • List allocation models for a portfolio.
      GET
    • Create or update an allocation model. PublicId in body determines insert vs update; absent/empty = insert.
      POST
    • Get the active allocation model for a portfolio (or null).
      GET
    • Get a single allocation model by its public id.
      GET
    • Soft-delete an allocation model.
      DELETE
    • Mark a model active (clears the active flag on all others for the portfolio).
      POST
    • Compute the trades that, applied to the portfolio, would move it toward the active (or specified) allocation model under the given user-supplied constraints. Pure deterministic math — not financial advice.
      POST
  • Schemas
    • Sample Schemas
      • Pet
      • Category
      • Tag
    • Schemas
      • AccountLinkSettings
      • AccountSettings
      • AccountLinkViewModel
      • AddClientVM
      • AddTradeModel
      • AddPriceModel
      • AddClientModel
      • ApplicationUser
      • AuthorizeTokenRequest
      • BenchmarkSettings
      • CalculationSettings
      • AdjustmentData
      • CategoryPerformancePreferenceOptions
      • ChartPreferenceOptions
      • AssignPortfolioToClientVM
      • ChecklistItem
      • Client
      • AutomationSettings
      • ClientExpanded
      • CGTDistributionsModel
      • BillingSettings
      • ClientModel
      • CGTError
      • ClientPortfolio
      • CGTEventModel
      • ClientVM
      • CGTReportModel
      • ColumnSettings
      • ComponentColumn
      • CapitalGainLoss
      • ComponentSettings
      • CapitalGainsBreakdown
      • CreateCashAccountVM
      • CapitalGainsTaxSummary
      • CreateCashTransactionVM
      • CapitalGainsTaxSummaryModel
      • CreateComponentDTO
      • CashInterest
      • CreatePortfolioSettingsModel
      • CryptoIncome
      • CryptoTrade2
      • CustomGroupCategory
      • DiversificationPreferenceOptions
      • Dividend
      • ClientPortfolioVM
      • DividendDTO
      • DividendError
      • EmailSettings
      • EmbeddedComponent
      • FilterCriteria
      • CompanyListResponseDTO
      • GroupAccount
      • CompanyManagementDTO
      • GroupAccountResponse
      • GetPriceModel
      • GroupUserAdd
      • GroupUserLookup
      • CreateProPortfolioVM
      • GroupUserResponse
      • GroupUserUpdate
      • CryptoIncomeDTO
      • Holding
      • CryptoIncomeSummary
      • HoldingClassification
      • HoldingModel
      • HoldingNote
      • DateRange
      • HoldingPerformancePreferenceOptions
      • DeductionsSummary
      • HoldingPublisherData
      • HoldingSettingsModel
      • CryptocurrencyListResponseDTO
      • HoldingTaxSettings
      • CryptocurrencyManagementDTO
      • HoldingType
      • DividendData
      • IHoldingSettings
      • CustomerProfileDto
      • IncomeContributionsSettings
      • CustomerSearchResultDto
      • IncomeReturnPreferenceOptions
      • IntegrationMethodAccuracy
      • IntegrationMethodSupportLevel
      • ForeignTaxableIncomeSummary
      • IntegrationType
      • IntercomSettings
      • IosIapPurchase
      • IosIapSubscriptionInfo
      • ManageClientModel
      • Metadata
      • OnboardingChecklist
      • OnboardingSurvey
      • OverviewPreferences
      • OwnerPlan
      • GicIndustry
      • PaymentPlatform
      • GicIndustryGroup
      • Portfolio
      • GicSector
      • PortfolioDiviersifcationSettings
      • GicSubIndustry
      • PortfolioPreferences
      • HoldingReturnViewModel
      • PortfolioRequest
      • PortfolioSettings
      • PortfolioHoldingModel
      • HoldingSummaryPerformanceViewModel
      • PortfolioTaxSetting
      • PortfolioModel
      • PortfolioType
      • HoldingTaxSettingsVM
      • HoldingSymbolUpdateModel
      • ProRataTotals
      • HoldingTaxSettingsDTO
      • ProRegisterModel
      • HoldingTypeEnum
      • Provider
      • ProviderIntegrationMethod
      • SaleAllocationStrategies
      • IncomeIntegrationMapping
      • SharingSettings
      • IncomeIntegrationMappingDto
      • SubscriptionPlan
      • IncomeRecord
      • ImpersonationRequestDto
      • TestimonialInformation
      • ImpersonationResponseDto
      • TimeSpan
      • TrackingInformation
      • Trade
      • TradeMetadata
      • TradeType
      • InterestIncomeSummary
      • TradeTypeEnum
      • UpdateCashAccountVM
      • UpdateCashTransactionVM
      • UpsertIncomeRecord
      • IntercomAdmin
      • UpsertPortfolioModel
      • UpdatePriceModel
      • MyTaxIncomeSummary
      • IntercomAvatar
      • UserPortfolio
      • MyTaxReportModel
      • IntercomCanvasContext
      • UserPreferences
      • IntercomCanvasInitializeDto
      • UserSharedWith
      • IntercomCanvasSubmitDto
      • IntercomContact
      • IntercomCustomer
      • IntercomRevokeAccessDto
      • PortfolioPerformanceViewModel
      • PortfolioTaxSettingDTO
      • PortfolioTaxSettingsVM
      • SharePortfoliosVM
      • NotificationSettings
      • TaxableIncomeReportModel
      • TaxableIncomeSummary
      • TotalReturnViewModel
      • TradeIntegrationMapping
      • StartImpersonationDto
      • StopImpersonationDto
      • TrialEligibilityDto
      • TrialResetRequestDto
      • TrialResetResponseDto
      • UpdateAccountSettingsDto
      • UpdateUserProfileDto
    • Navexa.API.Controllers.PublicAPI.AllocationModels.Models.PublicAllocationBucket
    • Navexa.API.Controllers.PublicAPI.AllocationModels.Models.PublicAllocationModel
    • Navexa.API.Controllers.PublicAPI.AllocationModels.Models.PublicCalculateRebalanceRequest
    • Navexa.API.Controllers.PublicAPI.AllocationModels.Models.PublicCalculateRebalanceResponse
    • Navexa.API.Controllers.PublicAPI.AllocationModels.Models.PublicDriftEntry
    • Navexa.API.Controllers.PublicAPI.AllocationModels.Models.PublicDriftReport
    • Navexa.API.Controllers.PublicAPI.AllocationModels.Models.PublicRebalanceLeg
    • Navexa.API.Controllers.PublicAPI.CashAccounts.ViewModels.CashTransactionViewModel
    • Navexa.API.Controllers.PublicAPI.CashAccounts.ViewModels.CreateCashAccountVM
    • Navexa.API.Controllers.PublicAPI.CashAccounts.ViewModels.CreateCashTransactionVM
    • Navexa.API.Controllers.PublicAPI.CashAccounts.ViewModels.GetCashAccountVM
    • Navexa.API.Controllers.PublicAPI.CashAccounts.ViewModels.UpdateCashAccountVM
    • Navexa.API.Controllers.PublicAPI.CashAccounts.ViewModels.UpdateCashTransactionVM
    • Navexa.API.Controllers.PublicAPI.Clients.ViewModels.AddClientVM
    • Navexa.API.Controllers.PublicAPI.Clients.ViewModels.ClientPortfolioVM
    • Navexa.API.Controllers.PublicAPI.Clients.ViewModels.ClientVM
    • Navexa.API.Controllers.PublicAPI.CustomInvestments.Models.AddPriceModel
    • Navexa.API.Controllers.PublicAPI.CustomInvestments.Models.BulkAddPricesModel
    • Navexa.API.Controllers.PublicAPI.CustomInvestments.Models.BulkPriceEntry
    • Navexa.API.Controllers.PublicAPI.CustomInvestments.Models.GetPriceModel
    • Navexa.API.Controllers.PublicAPI.CustomInvestments.Models.UpdatePriceModel
    • Navexa.API.Controllers.PublicAPI.Holdings.Models.HoldingIncomeModel
    • Navexa.API.Controllers.PublicAPI.Holdings.Models.HoldingModel
    • Navexa.API.Controllers.PublicAPI.Holdings.Models.HoldingSettingsModel
    • Navexa.API.Controllers.PublicAPI.Holdings.Models.HoldingSymbolUpdateModel
    • Navexa.API.Controllers.PublicAPI.Holdings.Models.HoldingTimeseriesRequest
    • Navexa.API.Controllers.PublicAPI.Holdings.Models.HoldingTradeModel
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.CreatePortfolioSettingsModel
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.DeletePortfolioResponse
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.HoldingReturnViewModel
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.HoldingSummaryPerformanceViewModel
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.PortfolioHoldingModel
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.PortfolioModel
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.PortfolioPerformanceViewModel
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.PortfolioTimeseriesRequest
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.PortfolioTransactionsRequest
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.PortfolioTransactionsResponse
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.SimulateSellRequest
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.SimulateSellResponse
    • Navexa.API.Controllers.PublicAPI.Portfolios.Models.UpsertPortfolioModel
    • Navexa.API.Controllers.PublicAPI.ProRataDistributions.Models.ProRataTotals
    • Navexa.API.Controllers.PublicAPI.Shared.Models.TimeseriesMeta
    • Navexa.API.Controllers.PublicAPI.Shared.Models.TimeseriesPoint
    • Navexa.API.Controllers.PublicAPI.Shared.Models.TimeseriesRange
    • Navexa.API.Controllers.PublicAPI.Shared.Models.TimeseriesResponse
    • Navexa.API.Controllers.PublicAPI.Shared.Models.TimeseriesSummary
    • Navexa.API.Controllers.PublicAPI.Sources.Models.SourceModel
    • Navexa.API.Controllers.PublicAPI.StocksIncome.Models.IncomeRecord
    • Navexa.API.Controllers.PublicAPI.StocksIncome.Models.UpsertIncomeRecord
    • Navexa.API.Controllers.PublicAPI.TaxReports.Models.CGTDistributionsModel
    • Navexa.API.Controllers.PublicAPI.TaxReports.Models.CGTEventModel
    • Navexa.API.Controllers.PublicAPI.TaxReports.Models.CGTReportModel
    • Navexa.API.Controllers.PublicAPI.TaxReports.Models.CapitalGainsTaxSummaryModel
    • Navexa.API.Controllers.PublicAPI.TaxReports.Models.TaxableIncomeReportModel
    • Navexa.API.Controllers.PublicAPI.TaxSettings.Models.HoldingTaxSettingsDTO
    • Navexa.API.Controllers.PublicAPI.TaxSettings.Models.PortfolioTaxSettingDTO
    • Navexa.API.Controllers.PublicAPI.Trades.Models.AddTradeModel
    • Navexa.API.Controllers.PublicAPI.Trades.Models.TradeModel
    • Navexa.API.Controllers.Reports.TaxReports.CapitalGainsTaxReport.Models.HoldingTaxSettingsVM
    • Navexa.API.Controllers.Reports.TaxReports.CapitalGainsTaxReport.Models.PortfolioTaxSettingsVM
    • Navexa.API.DTOs.CryptoIncomeDTO
    • Navexa.API.ViewModels.AccountLinkViewModel
    • Navexa.API.ViewModels.BenchmarkReturnViewModel
    • Navexa.API.ViewModels.TotalReturnViewModel
    • Navexa.Core.DomainModels.CGTError
    • Navexa.Core.DomainModels.CapitalGainLoss
    • Navexa.Core.DomainModels.CapitalGainsBreakdown
    • Navexa.Core.DomainModels.CapitalGainsTaxSummary
    • Navexa.Core.DomainModels.CryptoIncomeSummary
    • Navexa.Core.DomainModels.DateRange
    • Navexa.Core.DomainModels.DeductionsSummary
    • Navexa.Core.DomainModels.ForeignTaxableIncomeSummary
    • Navexa.Core.DomainModels.InterestIncomeSummary
    • Navexa.Core.DomainModels.MyTaxIncomeSummary
    • Navexa.Core.DomainModels.MyTaxReportModel
    • Navexa.Core.DomainModels.TaxableIncomeSummary
    • Navexa.Core.DomainModels.TotalReturn
    • Navexa.Core.Enums.AMITDataSource
    • Navexa.Core.Enums.HoldingTypeEnum
    • Navexa.Core.Models.HoldingClassification
    • Navexa.Core.Services.PortfolioFilter.Models.FilterCriteria
    • Navexa.Core.Services.PortfolioFilter.Models.TransactionFilterItem
    • Navexa.Core.Services.TaxServices.TaxReports.TaxableIncome.Models.CashInterest
  1. AllocationModels

Mark a model active (clears the active flag on all others for the portfolio).

POST
/v1/portfolios/{portfolioId}/allocation-models/{modelPublicId}/activate

Request

Authorization
API Key
Add parameter in header
Authorization
Example:
Authorization: ********************
or
Path Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v1/portfolios//allocation-models//activate' \
--header 'Authorization: <api-key>'

Responses

🟢200
Success
This response does not have a body.
🟠401
🟠404
Modified at 2026-05-17 10:02:35
Previous
Soft-delete an allocation model.
Next
Compute the trades that, applied to the portfolio, would move it toward the active (or specified) allocation model under the given user-supplied constraints. Pure deterministic math — not financial advice.
Built with