API reference Vaultody

POST /vaults/{vaultId}/vault-account

Create Vault Account

This endpoint creates a new Vault Account within a specified Vault. Each new Vault Account is created with a unique identifier and customizable display settings, such as name, color, and dashboard visibility.

Path parameters

vaultId string required

The ID of the vault for which a Vault Account will be created.

Query parameters

context string

In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. `context` is specified by the user.

Body parameters application/json

context string

data object required

item object required

color string required e.g. #00C7E6

Color code used to visually identify the Vault Account, it should be a valid hex.

isHiddenInDashboard boolean required

Indicates whether the vault account should be hidden from the dashboard.

name string required e.g. Vault Account Name

The name of the Vault Account being created.

Response

Returns 201 the resource has been successfully created.

apiVersion string required

Specifies the version of the API that incorporates this endpoint.

E.G. 2026-03-20

requestId string required

Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.

E.G. 601c1710034ed6d407996b30

context string

E.G. yourExampleString

data object required

item object required

addressesCount string required

The total number of addresses associated with this Vault Account.

E.G. 12

balances object[] required

assetId string required

The ID of the asset.

E.G. 691c92a08e6be3c9d32d2c8a

assetName string required

Asset name - bitcoin, binance-smart-chain, tron, solana.

E.G. Ethereum

assetUnit string required

The symbol of the asset.

E.G. ETH

blockchain string required

The blockchain of the asset.

E.G. ethereum

exchangeRateUnit string required

The pricing unit used when calculating exchange rates.

E.G. USD

latestExchangeRateToUSD string required

The most recent exchange rate of the currency relative to USD.

E.G. 2822.59

totalAmount string required

The total amount of this asset held in the Vault Account.

E.G. 0.123

createdAt integer required

Unix timestamp indicating when the Vault Account was created.

E.G. 1760621154

index string required

Internal sequential index of the Vault Account within the vault.

E.G. 1

isHiddenInDashboard boolean required

Indicates whether the vault account should be hidden from the dashboard.

vaultAccountColour string required

The assigned color of the Vault Account.

E.G. #5243AA

vaultAccountId string required

Unique ID of the newly created Vault Account.

E.G. 692d72c58cb7dd000704981a

vaultAccountName string required

The name of the Vault Account.

E.G. Vault Account Name

vaultId string required

The ID of the vault for which a Vault Account is created.

E.G. 66d866bd469e1d00079d91d5

Errors

400 The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination. application/json

401 The provided API key is invalid. Please, generate a new one from your Dashboard. application/json

403 Vault accounts can only be created for vaults of type DEFAULT. application/json

404 The specified resource has not been found. application/json

409 Failed to create vault account. A vault account with index {index} already exists. application/json

415 The selected Media Type is unavailable. The Content-Type header should be 'application/json'. application/json

422 Your request body for POST requests must have a structure of { data: { item: [...properties] } } application/json

429 The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan. application/json

500 An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email. application/json