Controls movement for this source. active permits entry and exit; subscription_only permits entry only; redemption_only permits exit only; disabled permits neither.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Ground","description":"Ground developer documentation for Portfolio Wallets, gtokens, MicroVaults, and webhooks.","colors":{"primary":"#0F172A","light":"#334155","dark":"#0F172A"},"logo":{"light":"https://mintcdn.com/braid-4d08f2b7/T2beshx6Z6tR-K1c/docs/assets/ground-logo-mark-white-on-black.svg?fit=max\u0026auto=format\u0026n=T2beshx6Z6tR-K1c\u0026q=85\u0026s=2b62d5630a4091f5e3fa3291cf94e7cc","dark":"https://mintcdn.com/braid-4d08f2b7/T2beshx6Z6tR-K1c/docs/assets/ground-logo-mark-white-on-black.svg?fit=max\u0026auto=format\u0026n=T2beshx6Z6tR-K1c\u0026q=85\u0026s=2b62d5630a4091f5e3fa3291cf94e7cc","href":"https://groundtech.co"},"favicon":{"light":"https://mintcdn.com/braid-4d08f2b7/T2beshx6Z6tR-K1c/docs/assets/favicon.svg?fit=max\u0026auto=format\u0026n=T2beshx6Z6tR-K1c\u0026q=85\u0026s=b4171decaf67f0eb8c4959bbf7e273bc","dark":"https://mintcdn.com/braid-4d08f2b7/T2beshx6Z6tR-K1c/docs/assets/favicon.svg?fit=max\u0026auto=format\u0026n=T2beshx6Z6tR-K1c\u0026q=85\u0026s=b4171decaf67f0eb8c4959bbf7e273bc"},"api":{"playground":{"proxy":true}},"footer":{"links":[{"header":"Docs","items":[{"label":"Introduction","href":"/docs/introduction"},{"label":"Quickstart","href":"/docs/portfolio-wallets/quickstart"},{"label":"API Conventions","href":"/docs/portfolio-wallets/api-conventions"},{"label":"Portfolio Wallets","href":"/docs/portfolio-wallets/create-wallet"},{"label":"MicroVaults","href":"/docs/microvaults/introduction"}]},{"header":"Reference","items":[{"label":"Portfolio Wallet API","href":"/api-reference/list-portfolio-wallet-yield-sources"},{"label":"gtoken API","href":"/api-reference/list-gtoken-yield-sources"},{"label":"MicroVault API","href":"/api-reference/list-microvaults"}]}]},"fonts":{"heading":{"family":"Inter","weight":600},"body":{"family":"Inter","weight":400}},"styling":{"codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":true},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"interaction":{"drilldown":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"braid-4d08f2b7","hasAudioNarration":false,"actualSubdomain":"braid-4d08f2b7","customDomains":["docs.groundtech.co"],"gitSource":{"type":"github","owner":"ground-technology","repo":"ground-monorepo","deployBranch":"mintlify-deployment","contentDirectory":"apps/api/mintlify","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae08857d674d5fcdf0fe2d5","collectionId":"a0d35e70-09d4-40c6-9146-5838980a3620","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae08857d674d5fcdf0fe2d5"},"entitlements":{},"buildId":"6ae093912ea1296893ea475d","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API Reference","count":71},{"language":"default","tag":"Portfolio Wallets","count":60},{"language":"default","tag":"MicroVaults","count":36},{"language":"default","tag":"gtokens","count":33},{"language":"default","tag":"Getting Started","count":15},{"language":"default","tag":"Webhooks","count":12},{"language":"default","tag":"Vaults and Sources","count":10},{"language":"default","tag":"Wallet Lifecycle","count":9},{"language":"default","tag":"Wallets","count":8},{"language":"default","tag":"Integration Guides","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"#navigation-items .nav-anchor[href^=\"/docs/introduction#\"]{margin-left:2rem;margin-bottom:.5rem;font-weight:400}#navigation-items .nav-anchor[href^=\"/docs/introduction#\"]>div{display:none}#navigation-items:has(.nav-anchor[href^=\"/docs/introduction#\"]){display:flex;flex-direction:column}#navigation-items:has(.nav-anchor[href^=\"/docs/introduction#\"])>ul{order:1}#navigation-items:has(.nav-anchor[href^=\"/docs/introduction#\"])>div:has(a[href=\"/docs/introduction\"]){order:0;margin-top:0;margin-bottom:.5rem}"}],"page":{"pagePath":"api-reference/update-microvault-source-mode","slug":"/api-reference/update-microvault-source-mode","pageMetadata":{"title":"Update MicroVault source mode","openapi":"swagger/swagger-combined.yaml PUT /v2/microvaults/vaults/{vaultId}/sources/{sourceId}/mode","description":"Controls whether the vault may enter, exit, both, or stop using a source. It does not change the target or erase an existing position.","href":"/api-reference/update-microvault-source-mode"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Controls whether the vault may enter, exit, both, or stop using a source. It does not change the target or erase an existing position.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components};return _jsx(_components.p,{children:`Control whether a yield source may receive subscriptions, service redemptions, do both, or remain disabled.`})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"title":"Update MicroVault source mode","openapi":"swagger/swagger-combined.yaml PUT /v2/microvaults/vaults/{vaultId}/sources/{sourceId}/mode","description":"Controls whether the vault may enter, exit, both, or stop using a source. It does not change the target or erase an existing position.","href":"/api-reference/update-microvault-source-mode"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["MicroVaults"],"operationId":"updateMicrovaultSourceMode","summary":"Update a source mode","description":"Controls whether the vault may enter, exit, both, or stop using a source. It does not change the target or erase an existing position.","parameters":["e2438e83-d26d-4f3f-952c-8c2b17a7ad74"],"requestBody":"af19f058-e58e-43e4-8b3c-89bfca975be8","responses":{"202":"6d3ad732-d824-4f18-90ee-3ff2bdac5060","400":"6936a31d-73a1-4278-9c00-1c39d039ecf3","401":"5ce6bb61-223d-498b-8422-0d0fe88b6795","409":"a63ddcb6-eefe-4fa8-8bb5-9535c389933e"},"method":"put","type":"path","servers":["4c1e0bd9-0228-4e96-b858-9f5ad19f1386","eab9aa06-a1ca-4f31-a8ca-cbf3e6fb205f"],"security":["5da4b017-3eca-46bb-b879-e68ce4273d94"],"path":"/v2/microvaults/vaults/{vaultId}/sources/{sourceId}/mode","baseUrlOptions":["https://sandbox.groundtech.co","https://production.groundtech.co"],"title":"Update a source mode","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e2438e83-d26d-4f3f-952c-8c2b17a7ad74":{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"description":"Unique key for this intended change. Reuse it only when retrying the identical request.","uniqueKey":"","typeLabel":"string"},"description":"Unique key for this intended change. Reuse it only when retrying the identical request."},"2fca00d1-1666-47a9-87da-f97577dddc1c":{"name":"vaultId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$","example":"8f4c52d7-62ab-4db9-a964-92f481f6b851","isRequired":true,"description":"Ground identifier of the MicroVault whose source permissions will change.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"Ground identifier of the MicroVault whose source permissions will change."},"66eb8f8e-f285-4667-af32-817ef2f3e658":{"name":"sourceId","in":"path","required":true,"schema":{"type":"string","pattern":"^0x[0-9a-fA-F]{64}$","example":"0x1111111111111111111111111111111111111111111111111111111111111111","isRequired":true,"description":"Identifier of the admitted yield source whose entry and exit permissions will change.","uniqueKey":"","typeLabel":"string"},"description":"Identifier of the admitted yield source whose entry and exit permissions will change."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["mode"],"properties":{"mode":{"type":"string","enum":["active","subscription_only","redemption_only","disabled"],"description":"Controls movement for this source. `active` permits entry and exit; `subscription_only` permits entry only; `redemption_only` permits exit only; `disabled` permits neither.","isRequired":true,"uniqueKey":"mode","typeLabel":"enum\u003cstring>"}},"example":{"mode":"redemption_only"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"mode":"redemption_only"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"6d3ad732-d824-4f18-90ee-3ff2bdac5060":{"description":"The operation was accepted.","content":{"application/json":{"schema":{"type":"object","required":["task"],"properties":{"task":{"type":"object","description":"Asynchronous change accepted for submission and onchain confirmation.","required":["id","kind","status","vaultId","txHashes","error","createdAt","updatedAt"],"example":{"id":"924c9b2d-3a9c-4b1a-b470-c73fc9b97c06","kind":"update_strategy","status":"submitted","vaultId":"d9902b20-6499-4465-a4c3-5d2208182f79","txHashes":["0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"],"error":null,"createdAt":"2026-09-10T18:42:10.000Z","updatedAt":"2026-09-10T18:42:12.000Z"},"properties":{"id":{"type":"string","description":"Identifier for tracking this requested MicroVault change.","format":"uuid","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$","example":"8f4c52d7-62ab-4db9-a964-92f481f6b851","isRequired":true,"uniqueKey":"task.id","typeLabel":"string\u003cuuid>"},"kind":{"type":"string","enum":["provision_vault","update_strategy","update_source_mode","update_fees","update_pause","add_shareholder","remove_shareholder","rebalance"],"description":"Change being performed by this public API task.","isRequired":true,"uniqueKey":"task.kind","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["queued","submitting","submitted","confirmed","failed"],"description":"Current submission and onchain-confirmation state of the change.","isRequired":true,"uniqueKey":"task.status","typeLabel":"enum\u003cstring>"},"vaultId":{"oneOf":[{"type":"string","description":"Ground MicroVault identifier affected by the task, or `null` until a new vault record exists.","format":"uuid","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$","example":"8f4c52d7-62ab-4db9-a964-92f481f6b851","isRequired":true,"uniqueKey":"task.vaultId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","isRequired":true,"uniqueKey":"task.vaultId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.vaultId","typeLabel":"string\u003cuuid> | null"},"txHashes":{"type":"array","items":{"type":"string","pattern":"^0x[0-9a-fA-F]{64}$","uniqueKey":"task.txHashes.items.[INDEX]","typeLabel":"string"},"description":"Onchain transaction hashes submitted for this task.","isRequired":true,"uniqueKey":"task.txHashes","typeLabel":"string[]"},"error":{"oneOf":[{"type":"string","description":"Failure reason when `status` is `failed`; otherwise `null`.","isRequired":true,"uniqueKey":"task.error.oneOf.0","typeLabel":"string"},{"type":"null","description":"Failure reason when `status` is `failed`; otherwise `null`.","isRequired":true,"uniqueKey":"task.error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"task.error","typeLabel":"string | null"},"createdAt":{"type":"string","format":"date-time","description":"Time when Ground accepted the change.","isRequired":true,"uniqueKey":"task.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"Time when the task status last changed.","isRequired":true,"uniqueKey":"task.updatedAt","typeLabel":"string\u003cdate-time>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"task","typeLabel":"object"}},"example":{"task":{"id":"924c9b2d-3a9c-4b1a-b470-c73fc9b97c06","kind":"update_strategy","status":"submitted","vaultId":"d9902b20-6499-4465-a4c3-5d2208182f79","txHashes":["0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"],"error":null,"createdAt":"2026-09-10T18:42:10.000Z","updatedAt":"2026-09-10T18:42:12.000Z"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"task":{"id":"924c9b2d-3a9c-4b1a-b470-c73fc9b97c06","kind":"update_strategy","status":"submitted","vaultId":"d9902b20-6499-4465-a4c3-5d2208182f79","txHashes":["0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"],"error":null,"createdAt":"2026-09-10T18:42:10.000Z","updatedAt":"2026-09-10T18:42:12.000Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"6936a31d-73a1-4278-9c00-1c39d039ecf3":{"description":"Invalid request.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","example":"invalid_request","description":"Stable machine-readable error code.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"oneOf":[{"type":"string","example":"allocation targets and idleTargetBps must total 10000","description":"Human-readable explanation of why the request failed, when available.","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","example":"allocation targets and idleTargetBps must total 10000","description":"Human-readable explanation of why the request failed, when available.","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"details":{"oneOf":[{"description":"Structured context for the error, when available.","uniqueKey":"details.oneOf.0","typeLabel":"any"},{"description":"Structured context for the error, when available.","type":"null","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"any | null"}},"example":{"error":"invalid_request","message":"allocation targets and idleTargetBps must total 10000"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"invalid_request","message":"allocation targets and idleTargetBps must total 10000"}}},"exampleType":"generated"}},"exampleType":"generated"},"5ce6bb61-223d-498b-8422-0d0fe88b6795":{"description":"The request is missing a valid bearer token, or the token is invalid or expired.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Authentication or authorization error message.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"Additional auth middleware detail, when present.","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Additional auth middleware detail, when present.","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","enum":["unauthenticated","forbidden"],"description":"Some auth and scope failures include a stable code; middleware errors may omit it.","uniqueKey":"code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["unauthenticated","forbidden"],"description":"Some auth and scope failures include a stable code; middleware errors may omit it.","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Unauthenticated request","message":"Missing or invalid bearer token"},"examples":{"Example":{"title":"Example","value":{"error":"Unauthenticated request","message":"Missing or invalid bearer token"}}},"exampleType":"examples"}},"exampleType":"examples"},"a63ddcb6-eefe-4fa8-8bb5-9535c389933e":{"description":"Conflicting request.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","example":"invalid_request","description":"Stable machine-readable error code.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"oneOf":[{"type":"string","example":"allocation targets and idleTargetBps must total 10000","description":"Human-readable explanation of why the request failed, when available.","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","example":"allocation targets and idleTargetBps must total 10000","description":"Human-readable explanation of why the request failed, when available.","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"details":{"oneOf":[{"description":"Structured context for the error, when available.","uniqueKey":"details.oneOf.0","typeLabel":"any"},{"description":"Structured context for the error, when available.","type":"null","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"any | null"}},"example":{"error":"invalid_request","message":"allocation targets and idleTargetBps must total 10000"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"invalid_request","message":"allocation targets and idleTargetBps must total 10000"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"5da4b017-3eca-46bb-b879-e68ce4273d94":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"4c1e0bd9-0228-4e96-b858-9f5ad19f1386":{"url":"https://sandbox.groundtech.co"},"eab9aa06-a1ca-4f31-a8ca-cbf3e6fb205f":{"url":"https://production.groundtech.co"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"swagger/swagger-combined.yaml"},"subdomain":"braid-4d08f2b7","siteName":"Ground","title":"Update MicroVault source mode - Ground","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-14T16:02:06.319Z","originalFileLocation":"api-reference/update-microvault-source-mode.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Controls whether the vault may enter, exit, both, or stop using a source. It does not change the target or erase an existing position.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ground\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/braid-4d08f2b7/aZx8N-g1imgxwXxV/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/braid-4d08f2b7/aZx8N-g1imgxwXxV/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/braid-4d08f2b7/aZx8N-g1imgxwXxV/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/braid-4d08f2b7/aZx8N-g1imgxwXxV/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/braid-4d08f2b7/aZx8N-g1imgxwXxV/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/braid-4d08f2b7/aZx8N-g1imgxwXxV/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/braid-4d08f2b7/aZx8N-g1imgxwXxV/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/braid-4d08f2b7/aZx8N-g1imgxwXxV/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/braid-4d08f2b7/aZx8N-g1imgxwXxV/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update MicroVault source mode - Ground\">\u003cmeta data-mint-head property=\"og:description\" content=\"Controls whether the vault may enter, exit, both, or stop using a source. It does not change the target or erase an existing position.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ground\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.groundtech.co/api-reference/update-microvault-source-mode\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://braid-4d08f2b7.mintlify.app/_mintlify/api/og/v2?division=Vaults+and+Sources\u0026amp;title=Update+MicroVault+source+mode\u0026amp;description=Controls+whether+the+vault+may+enter%2C+exit%2C+both%2C+or+stop+using+a+source.+It+does+not+change+the+target+or+erase+an+existing+position.\u0026amp;theme=a63f7a1c49707387ffb29914\u0026amp;signature=2207ce1187c165852b9d3115cbc48f70c0485a03aa85ab4e5730905e8b47b642\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update MicroVault source mode - Ground\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Controls whether the vault may enter, exit, both, or stop using a source. It does not change the target or erase an existing position.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://braid-4d08f2b7.mintlify.app/_mintlify/api/og/v2?division=Vaults+and+Sources\u0026amp;title=Update+MicroVault+source+mode\u0026amp;description=Controls+whether+the+vault+may+enter%2C+exit%2C+both%2C+or+stop+using+a+source.+It+does+not+change+the+target+or+erase+an+existing+position.\u0026amp;theme=a63f7a1c49707387ffb29914\u0026amp;signature=2207ce1187c165852b9d3115cbc48f70c0485a03aa85ab4e5730905e8b47b642\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/braid-4d08f2b7/aZx8N-g1imgxwXxV/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ground\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0F172A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.groundtech.co/api-reference/update-microvault-source-mode\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/update-microvault-source-mode.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.groundtech.co/#organization\",\"name\":\"Ground\",\"url\":\"https://docs.groundtech.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/braid-4d08f2b7/T2beshx6Z6tR-K1c/docs/assets/ground-logo-mark-white-on-black.svg?fit=max\u0026auto=format\u0026n=T2beshx6Z6tR-K1c\u0026q=85\u0026s=2b62d5630a4091f5e3fa3291cf94e7cc\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.groundtech.co#website\",\"name\":\"Ground\",\"url\":\"https://docs.groundtech.co\",\"publisher\":{\"@id\":\"https://docs.groundtech.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.groundtech.co/api-reference/update-microvault-source-mode#webpage\",\"url\":\"https://docs.groundtech.co/api-reference/update-microvault-source-mode\",\"name\":\"Update MicroVault source mode\",\"description\":\"Controls whether the vault may enter, exit, both, or stop using a source. It does not change the target or erase an existing position.\",\"dateModified\":\"2026-09-14T16:02:06.319Z\",\"isPartOf\":{\"@id\":\"https://docs.groundtech.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.groundtech.co/api-reference/update-microvault-source-mode#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.groundtech.co/api-reference/update-microvault-source-mode#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.groundtech.co/api-reference/list-microvaults\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Vaults and Sources\",\"item\":\"https://docs.groundtech.co/api-reference/list-microvaults\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update MicroVault source mode\",\"item\":\"https://docs.groundtech.co/api-reference/update-microvault-source-mode\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.groundtech.co/api-reference/update-microvault-source-mode#apireference\",\"headline\":\"Update MicroVault source mode\",\"name\":\"Update MicroVault source mode\",\"description\":\"Controls whether the vault may enter, exit, both, or stop using a source. It does not change the target or erase an existing position.\",\"url\":\"https://docs.groundtech.co/api-reference/update-microvault-source-mode\",\"mainEntityOfPage\":{\"@id\":\"https://docs.groundtech.co/api-reference/update-microvault-source-mode#webpage\"},\"dateModified\":\"2026-09-14T16:02:06.319Z\",\"publisher\":{\"@id\":\"https://docs.groundtech.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.groundtech.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ground\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Ground","nav":{"global":null,"tabs":[{"tab":"Overview","pages":[{"title":"Overview","href":"/docs/introduction"}]},{"tab":"Portfolio Wallets","pages":[{"title":"Portfolio Wallets","href":"/docs/portfolio-wallets/introduction"}]},{"tab":"gtokens","pages":[{"title":"gtokens","href":"/docs/gtokens/introduction"}]},{"tab":"MicroVaults","groups":[{"group":"Getting Started","pages":[{"title":"MicroVaults","href":"/docs/microvaults/introduction"},{"title":"MicroVault quickstart","href":"/docs/microvaults/quickstart"},{"title":"Concepts and control model","href":"/docs/microvaults/concepts"},{"title":"Supported chains and yield sources","href":"/docs/microvaults/supported-chains-and-sources"}]},{"group":"Vault Lifecycle","pages":[{"title":"Create a MicroVault","href":"/docs/microvaults/create-vault"},{"title":"Manage shareholders","href":"/docs/microvaults/shareholders"},{"title":"Configure strategy and source modes","href":"/docs/microvaults/strategy"},{"title":"Configure fees","href":"/docs/microvaults/fees"},{"title":"Subscribe from an external wallet","href":"/docs/microvaults/subscribe"},{"title":"Redeem MicroVault shares","href":"/docs/microvaults/redeem"},{"title":"Export vault authority","href":"/docs/microvaults/export-authority"}]},{"group":"Operations","pages":[{"title":"Use emergency controls","href":"/docs/microvaults/emergency-controls"},{"title":"Synchronous and asynchronous operations","href":"/docs/microvaults/async-operations"},{"title":"Statuses, activity, and performance","href":"/docs/microvaults/status-and-performance"},{"title":"Sandbox testing","href":"/docs/microvaults/sandbox-testing"}]},{"group":"Resources","pages":[{"title":"MicroVault contracts","href":"/docs/microvaults/contracts"},{"title":"Security and trust model","href":"/docs/microvaults/security"}]},{"group":"API Reference","pages":[{"group":"Vaults and Sources","pages":[{"title":"List MicroVaults","openapi":"swagger/swagger-combined.yaml GET /v2/microvaults/vaults","href":"/api-reference/list-microvaults"},{"title":"Create a MicroVault","openapi":"swagger/swagger-combined.yaml POST /v2/microvaults/vaults","href":"/api-reference/create-microvault"},{"title":"Get a MicroVault","openapi":"swagger/swagger-combined.yaml GET /v2/microvaults/vaults/{vaultId}","href":"/api-reference/get-microvault"},{"title":"List MicroVault yield sources","openapi":"swagger/swagger-combined.yaml GET /v2/microvaults/yield-sources","href":"/api-reference/list-microvault-yield-sources"},{"title":"List MicroVault source positions","openapi":"swagger/swagger-combined.yaml GET /v2/microvaults/vaults/{vaultId}/sources","href":"/api-reference/list-microvault-sources"},{"title":"Update MicroVault strategy","openapi":"swagger/swagger-combined.yaml PUT /v2/microvaults/vaults/{vaultId}/strategy","description":"Sets the vault's target allocation across idle base assets and admitted yield sources. Ground automation subsequently moves assets toward the new targets.","href":"/api-reference/update-microvault-strategy"},{"title":"Update MicroVault source mode","openapi":"swagger/swagger-combined.yaml PUT /v2/microvaults/vaults/{vaultId}/sources/{sourceId}/mode","href":"/api-reference/update-microvault-source-mode"},{"title":"Update MicroVault fees","openapi":"swagger/swagger-combined.yaml PUT /v2/microvaults/vaults/{vaultId}/fees","description":"Replaces the vault's management fee, performance fee, and fee-share recipient. The complete fee policy must be supplied on every update.","href":"/api-reference/update-microvault-fees"},{"title":"Update MicroVault pause controls","openapi":"swagger/swagger-combined.yaml PUT /v2/microvaults/vaults/{vaultId}/pause","href":"/api-reference/update-microvault-pause"},{"title":"Get MicroVault pause status","openapi":"swagger/swagger-combined.yaml GET /v2/microvaults/vaults/{vaultId}/pause-status","href":"/api-reference/get-microvault-pause-status"}]},{"group":"Performance and Activity","pages":[{"title":"Get MicroVault performance summary","openapi":"swagger/swagger-combined.yaml GET /v2/microvaults/performance-summary","href":"/api-reference/get-microvault-performance-summary"},{"title":"Get MicroVault performance series","openapi":"swagger/swagger-combined.yaml GET /v2/microvaults/vaults/{vaultId}/performance-series","href":"/api-reference/get-microvault-performance-series"},{"title":"List MicroVault activity","openapi":"swagger/swagger-combined.yaml GET /v2/microvaults/vaults/{vaultId}/activity","href":"/api-reference/list-microvault-activity"}]},{"group":"Shareholders","pages":[{"title":"Get MicroVault shareholders","openapi":"swagger/swagger-combined.yaml GET /v2/microvaults/vaults/{vaultId}/shareholders","href":"/api-reference/get-microvault-shareholders"},{"title":"Add a MicroVault shareholder","openapi":"swagger/swagger-combined.yaml PUT /v2/microvaults/vaults/{vaultId}/shareholders/{walletAddress}","href":"/api-reference/add-microvault-shareholder"},{"title":"Remove a MicroVault shareholder","openapi":"swagger/swagger-combined.yaml DELETE /v2/microvaults/vaults/{vaultId}/shareholders/{walletAddress}","href":"/api-reference/remove-microvault-shareholder"},{"title":"Get shareholder proof","openapi":"swagger/swagger-combined.yaml GET /v2/microvaults/vaults/{vaultId}/shareholders/{walletAddress}/proof","href":"/api-reference/get-microvault-shareholder-proof"}]},{"group":"Redemptions","pages":[{"title":"Preview a MicroVault redemption","openapi":"swagger/swagger-combined.yaml POST /v2/microvaults/vaults/{vaultId}/redemptions/preview","href":"/api-reference/preview-microvault-redemption"},{"title":"Get a requested redemption","openapi":"swagger/swagger-combined.yaml GET /v2/microvaults/vaults/{vaultId}/redemptions/{requestId}","href":"/api-reference/get-microvault-redemption"}]}]}]}]},"title":"Update MicroVault source mode - Ground","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}