Skip to main content
PUT
/
platform
/
admin
/
tenant
/
wallets
/
{id}
/
name
Update wallet name
curl --request PUT \
  --url https://api.example.com/platform/admin/tenant/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"
  }
}

​
Description

Changes the display name of a wallet. This operation updates the wallet’s label in the system without affecting blockchain state or wallet functionality.

​
Input

  • id (long, required) - The wallet tenant identifier (route parameter)
  • Request body containing:
    • name (string, required) - The new display name for the wallet

​
Output

Returns a containing:
  • success (bool) - Indicates if the operation succeeded
  • message (string, optional) - Additional information about the operation

​
Examples

Request 
PUT /api/platform/wallets/2048/name
{
  "name": "Updated Operations Wallet"
}
Response (200 OK) 
{
  "success": true,
  "message": "Wallet name updated successfully"
}

​
Errors

  • 400 Bad Request: Invalid identifier, empty name, or name exceeds maximum length.
  • 401 Unauthorized: Authentication token is missing or invalid.
  • 403 Forbidden: User does not have permission to update the wallet name.
  • 404 Not Found: Wallet with the specified identifier does not exist.
  • 500 Internal Server Error: An unexpected error occurred while updating the wallet name.

​
Notes

The wallet name is for display purposes only and does not affect blockchain operations. Both EOA and multisignature wallets can be renamed using this endpoint.

Path Parameters

​
id
integer<int64>
required

Identifier of the wallet tenant.

Query Parameters

​
api-version
string | null

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

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 }