Skip to main content
POST
UpdateWallet
Requires full access. Update a wallet’s name or status by its address. Provide at least one of the two. An empty value means no change. status accepts only STATUS_ACTIVE or STATUS_ARCHIVED.

Authorizations

x-mtoken
string
header
required

Your API token. Required for all API requests.

Body

application/json

Locates a wallet by address. At least one of name and status must be set; both can be set together.

address
string
required

Address of the wallet in the network.

Example:

"<string>"

name
string

The wallet's new name. Empty means no change. Leading and trailing whitespace is removed and runs of whitespace become one space before the name is checked: the result must be 1 to 85 Unicode code points and must not contain :, < or >.

Example:

"my wallet"

status
string

The wallet's new status. Empty means no change. Exactly STATUS_ACTIVE or STATUS_ARCHIVED (case-sensitive); any other value is rejected. Use STATUS_ARCHIVED to archive a wallet and STATUS_ACTIVE to unarchive an archived wallet, which must fit the organization's wallet limit. A wallet that is still pending cannot change status.

Example:

"STATUS_ACTIVE"

Response

200 - application/json

OK

details
object | null
error
object | null

Exactly one of the two error code fields is set.