LedgerAccounts

Archive or unarchive portfolio accounts

Sets active state for unique accounts in the active portfolio. Requires ledger-account update permission and Advanced Ledger; unavailable Advanced Ledger returns HTTP 403 (FeatureNotEnabledError). Existing account safety checks apply.

post/v1/portfolios/{portfolioSlug}/ledger-accounts/archive/bulk

Request

  • Base URL: https://api.tokenbooks.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.tokenbooks.io/v1/portfolios/{portfolioSlug}/ledger-accounts/archive/bulk
  • Auth: API key in header x-api-key

Path parameters

portfolioSlugstring required

Workspace-scoped portfolio slug

Request body

accountNumbersstring[] required

Ledger account numbers to update

isActiveboolean

Active state to set for all accounts. Defaults to false.

Response

Changes

No recorded changes to this operation across all 1 revision of this API.