API reference
Vaultody
PUT
/vaults/{vaultId}/vault-accounts/{vaultAccountId}/edit
Update Vault Account
This endpoint allows you to modify the attributes of an existing Vault Account.
Path parameters
vaultAccountId
string
required
Unique identifier of the Vault Account.
vaultId
string
required
The ID of the vault for which a Vault Account is 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
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.
data
object
required
item
object
required
color
string
e.g. #00A3BF
A HEX color value used to uniquely visually style this Vault Account in dashboards.
isFavoriteInDashboard
boolean
e.g. 1
Indicates whether the Vault Account has been marked as a "favorite" in the dashboard.
isHiddenInDashboard
boolean
e.g. 1
Specifies whether this Vault Account is hidden from the main dashboard view.
name
string
e.g. Vault Account Name
The name of the Vault Account.
Response
Returns 200 the request has been successful.
apiVersion
string
required
Specifies the version of the API that incorporates this endpoint.
requestId
string
required
Defines the ID of the request. The `requestId` is generated by Vaultody and it's unique for every request.
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.
data
object
required
item
object
required
addressesCount
string
required
The total number of addresses associated with this Vault Account.
createdAt
integer
required
The UNIX timestamp indicating when the Vault Account was first created.
index
string
required
The sequential index of this Vault Account within its parent Vault.
isHiddenInDashboard
boolean
required
Specifies whether this Vault Account is hidden from the main dashboard view.
vaultAccountColour
string
required
A HEX color value used to uniquely visually style this Vault Account in dashboards.
vaultAccountId
string
required
The unique id of the Vault Account.
vaultAccountName
string
required
The name of the Vault Account.
vaultId
string
required
The id of the Vault to which this Vault Account belongs.