> ## Documentation Index
> Fetch the complete documentation index at: https://v3.docs.derive.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a vault's off-chain metadata

> Applies an off-chain patch to a vault the caller curates, updating any of its display name, description, advisory mark-to-market cap (a USD decimal), or whitelist-only flag. Only the fields supplied are changed. The caller must own the vault's subaccount (i.e. be its curator); description length is capped.



## OpenAPI

````yaml /openapi.json post /private/update_vault_info
openapi: 3.1.0
info:
  title: Derive v3 API
  version: 0.2.0
  description: JSON-RPC 2.0 methods, served over WebSocket and HTTP POST.
servers:
  - url: https://api.derive.xyz/v3
    description: Production (HTTP POST base)
  - url: https://testnet.api.derive.xyz/v3
    description: Testnet (HTTP POST base)
security: []
tags:
  - name: Subaccounts
    description: >-
      List, inspect, and label subaccounts, portfolios, positions, and
      collateral.
  - name: Session Keys
    description: Register, edit, and list delegated signing keys.
  - name: Account
    description: Wallet-level account information and settings.
  - name: Orderbook
    description: Place, replace, cancel, and query orders, trigger orders, and algos.
  - name: RFQ
    description: 'Request-for-quote: send RFQs, quote, and execute block trades.'
  - name: Vault Shareholders
    description: >-
      Deposit into and withdraw from vaults, and track shares, requests, and
      performance.
  - name: Vault Curators
    description: >-
      Create and operate curated vaults: settle deposit and withdrawal requests,
      and manage vault metadata.
  - name: History
    description: >-
      Per-account historical records: orders, trades, transfers, and
      settlements.
  - name: Market Maker Protection
    description: Configure, read, and reset market-maker protection.
  - name: Transfers & Withdrawals
    description: Move collateral between subaccounts, to other wallets, and on-chain.
  - name: System
    description: Rate limits and transaction lookups.
  - name: Market Data
    description: Instruments, currencies, tickers, and market-wide feeds.
  - name: Referrals
    description: Referral codes and program performance.
  - name: Other
    description: Uncategorized.
paths:
  /private/update_vault_info:
    post:
      tags:
        - Vault Curators
      summary: Update a vault's off-chain metadata
      description: >-
        Applies an off-chain patch to a vault the caller curates, updating any
        of its display name, description, advisory mark-to-market cap (a USD
        decimal), or whitelist-only flag. Only the fields supplied are changed.
        The caller must own the vault's subaccount (i.e. be its curator);
        description length is capped.
      operationId: private_update_vault_info
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateVaultInfoRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OffchainAckResponse'
        default:
          description: JSON-RPC error (see Error Codes)
components:
  schemas:
    UpdateVaultInfoRequest:
      type: object
      required:
        - subaccount_id
      properties:
        description:
          default: null
          type:
            - string
            - 'null'
        mtm_cap:
          description: >-
            Advisory mark-to-market cap in USD, as a decimal string (e.g.
            `"1000"`).
          default: null
          type:
            - string
            - 'null'
          format: decimal
        name:
          default: null
          type:
            - string
            - 'null'
        subaccount_id:
          description: The vault's subaccount ID; the caller must be the vault's curator.
          type: integer
          format: uint64
          minimum: 0
        whitelist_only:
          default: null
          type:
            - boolean
            - 'null'
    OffchainAckResponse:
      description: >-
        A generic `{ "status": "ok" }` acknowledgement returned by
        fire-and-forget operations that have no data to return (e.g. updating
        account settings, MMP config, or the active currency).
      type: object
      required:
        - status
      properties:
        status:
          type: string

````

## Related topics

- [Create a Vault](/vaults/create-a-vault.md)
- [Session Keys](/authentication/session-keys.md)
- [Get a single vault by subaccount](/api-reference/vault-shareholders/get-a-single-vault-by-subaccount.md)