Skip to main content
PUT
/
tenant
/
{tenantId}
/
wallets
/
{id}
/
name
Updates the name of a wallet.
curl --request PUT \
  --url https://api.example.com/tenant/{tenantId}/wallets/{id}/name \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Treasury Wallet",
  "description": "Primary wallet for holding and distributing tokenized assets"
}
'
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

Path Parameters

​
tenantId
integer<int64>
required

Identifier of the tenant.

​
id
integer<int64>
required

Identifier of the wallet tenant.

Body

application/json

Request containing the new wallet name.

Represents a request to update a wallet's display name and description.

​
name
string

New display name for the wallet.

Example:

"Treasury Wallet"

​
description
string

Detailed description of the wallet's purpose or usage.

Example:

"Primary wallet for holding and distributing tokenized assets"

Response

200 - application/json

Wallet name updated successfully.

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object

The result value returned when the operation is successful.

Example:
{ "success": true }