Set currency name

Changes the current currency name.


Call URL

/currencies/(currencyAddress)/name

Type : PUT


Call request header parameters

Field Type Required/Optional Description Accepted values
wallet-address string Required The sender's wallet address. Any valid wallet address
wallet-key string Required The key of the sender's wallet. Any valid wallet key that unlocks the sender's wallet

Call request URL parameters

Field Type Required/Optional Description Accepted values
currencyAddress string Required The address of the involved currency. Any valid currency address

Call request body parameters

Field Type Required/Optional Description Accepted values
newCurrencyName string Required The new name for the currency token. Any string

Sample Call Request

https://api.tetrium.io/tokenize/currencies/0x29341b674091d600c227B137a457b0573515A7A8/name

Parameters:

{
   "newCurrencyName":"SampleCurrencyV2"
}

Call responses

Success response

Field Type Description Respond Values
status string Status of the API call. "success"
message string Information about the status. "set-currency-name initiated"
transactionHash string The hash of the transaction. To be used to verify the transaction's sealing status. Any string

Error response

Field Type Description Respond Values
status string Status of the API call. "fail"
error string Information about the error. (See below)

Information contained in error:

Error Messages Description
"missing newCurrencyName" newCurrencyName was not provided as a parameter in the API call body.
"invalid newCurrencyName" newCurrencyName provided was not in the correct format.

For any other errors, please refer to List of Common Error Messages

Sample Call Response

{
   "status":"success",
   "message":"set-currency-name initiated",
   "transactionHash":"0x4ad2ffaf954d38f83d250246e5ca14faa1dc71c9b0d87c1da577789b2edd6cb3"
}

results matching ""

    No results matching ""