Skip to main content
POST
Pauses automation for the portfolio. Idempotent — calling stop on an already-paused portfolio returns the current detail without side effects. Rebalance history, on-chain balances, and smart account positions are preserved while paused; call /start to resume automation.
  • Auth: x-api-key header (required)
  • Scope: portfolios:write
Concurrent start and stop calls on the same portfolio are last-writer wins. Both requests return 200 with the state each observed, so a client that issued the losing transition may briefly see stale status — re-fetch the portfolio detail if you need the post-race state. Returns 404 for portfolios your API key does not have access to — same response shape as a portfolio that doesn’t exist.
portfolioId
string
required
Portfolio identifier returned by POST /v2/enroll or GET /v2/portfolios.
Common error responses:
  • 400 when the portfolio has no rebalance schedule to transition
  • 401 when x-api-key header is missing or the key is invalid
  • 403 when the API key lacks the portfolios:write scope
  • 404 when the portfolio does not exist or does not belong to the tenant
  • 500 on unexpected server errors