Set currency member limit

Changes the current maximum number of currency members allowed for a currency.


Call URL

/currencies/(currencyAddress)/member-limit

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
newMemberLimit number (in string) Required The new limit for the number of currency members allowed. Any integer number in a string format and is bigger than "0" (limited to 16 digits in integer length).

Sample Call Request

https://api.tetrium.io/tokenize/currencies/0x29341b674091d600c227B137a457b0573515A7A8/member-limit

Parameters:

{
   "newMemberLimit":"100"
}

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-member-limit 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 newMemberLimit" newMemberLimit was not provided as a parameter in the API call body.
"invalid newMemberLimit" newMemberLimit provided was either not in a string format, lower than zero, or beyond the range allowed (Maximum 16 digits of integer).
"member limit smaller than total member" newMemberLimit provided was smaller than the current number of currency members. Please set a higher limit or remove some currency members to set a lower number.

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

Sample Call Response

{
   "status":"success",
   "message":"set-currency-member-limit initiated",
   "transactionHash":"0xa3b1ca43f4f383923752715ecc3d8051cdda838f3feda65bbea21dc5151c68c8"
}

results matching ""

    No results matching ""