Skip to main content
PUT
/
platform
/
admin
/
tenant
/
wallets
/
{id}
/
is_visible
Update wallet visibility status
curl --request PUT \
  --url https://api.example.com/platform/admin/tenant/wallets/{id}/is_visible
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

Changes the visibility status of a wallet. Hidden wallets are not displayed in standard wallet lists but remain accessible through direct queries and continue to function normally.

​
Input

  • id (long, required) - The wallet tenant identifier (route parameter)
  • value (bool, required) - The new visibility status (query parameter): true to make visible, false to hide

​
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/is-visible?value=false
Response (200 OK) 
{
  "success": true,
  "message": "Wallet visibility status updated successfully"
}

​
Errors

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

​
Notes

Hiding a wallet only affects its appearance in user interfaces. It does not prevent transactions or affect blockchain state. This is useful for archiving wallets without deactivating them.

Path Parameters

​
id
integer<int64>
required

Identifier of the wallet tenant.

Query Parameters

​
value
boolean

New visibility status value (true to make visible, false to hide).

​
api-version
string | null

Response

Wallet visibility status 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 }