Portfolio Archive
Archive or unarchive a portfolio
These endpoints allow you to archive and unarchive portfolios. Archiving a portfolio prevents further transactions and pauses any rebalance schedules.
Archive a Portfolio
Archives a portfolio, preventing further transactions and pausing rebalance schedules.
Path Parameters
The unique identifier of the portfolio to archive
Request Headers
Your API key
Must be set to application/json
Request Body
Reason for archiving the portfolio (optional)
Response
Indicates if the request was successful
Unarchive a Portfolio
Unarchives a previously archived portfolio, allowing transactions to resume.
Path Parameters
The unique identifier of the portfolio to unarchive
Request Headers
Your API key
Must be set to application/json
Request Body
Whether to resume previous rebalance schedules
Response
Indicates if the request was successful
Example Archive Request
Example Archive Response
Example Unarchive Request
Example Unarchive Response
Error Codes
The specified portfolio could not be found
Invalid or missing API key
The API key does not have permission to manage this portfolio
The portfolio is already in the requested state (e.g., archiving an already archived portfolio)
Notes
- Archiving a portfolio is a non-destructive action - no data or assets are removed
- All active rebalance schedules are automatically paused when a portfolio is archived
- When unarchiving, you can choose whether to resume previous rebalance schedules
- While archived, deposits, withdrawals, and other transactions will be rejected
- Portfolio data remains accessible for reporting and historical analysis
- The archive reason is stored for audit and reporting purposes