Class UpdateTokenParams

Represents the properties on a token definition that can be changed.
Any property set to 

null

on this object when submitted to the UpdateTokenAsync(ConsensusClient, UpdateTokenParams, Action<IConsensusContext>?) method will be left unchanged by the system. The transaction must be appropriately signed as described by the original Administrator endorsement in order to make changes. If there is no administrator endorsement specified, the token is immutable and cannot be changed.

Inheritance

object

TransactionParams

TransactionParams<TransactionReceipt>

UpdateTokenParams

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Hiero

Assembly: Hiero.dll

Syntax

public sealed class UpdateTokenParams : TransactionParams<TransactionReceipt>

Examples

Change the token's name, symbol, and memo. Any property left null is unchanged. Requires the Administrator key to sign:

// Update mutable token metadata. Only non-null properties are changed;
// leaving a key null leaves it untouched. Requires Administrator to
// sign. Immutable tokens (created with no Administrator) cannot be
// updated by anyone.
var receipt = await client.UpdateTokenAsync(new UpdateTokenParams
{
    Token = token,
    Name = "Renamed Token",
    Symbol = "RMT",
    Memo = "Rebranded 2026-Q2"
});
Console.WriteLine($"Update status: {receipt.Status}");

Properties

Administrator

Replace this Token's current administrative key signing requirements with new signing requirements.

Declaration

public Endorsement? Administrator { get; set; }

Property Value

Type	Description
Endorsement

Remarks

For this request to be accepted by the network, both the current private key(s) for this account and the new private key(s) must sign the transaction.
The existing key must sign for security and the new key must sign as a safeguard to avoid accidentally changing the key to an invalid value.

CancellationToken

Optional cancellation token to interrupt the token update submission process.

Declaration

public CancellationToken? CancellationToken { get; set; }

Property Value

Type	Description
CancellationToken?

ConfiscateEndorsement

Changes the administrator key for signing transactions that completely remove tokens from a crypto address.

Declaration

public Endorsement? ConfiscateEndorsement { get; set; }

Property Value

Type	Description
Endorsement

Expiration

If specified, changes the expiration to a new date, fees will be charged as appropriate.

Declaration

public ConsensusTimeStamp? Expiration { get; set; }

Property Value

Type	Description
ConsensusTimeStamp?

GrantKycEndorsement

Changes the administrator key for signing transactions updating the grant or revoke KYC status of an account.

Declaration

public Endorsement? GrantKycEndorsement { get; set; }

Property Value

Type	Description
Endorsement

Memo

If specified, updates the publicly visible memo to be associated with the token.

Declaration

public string? Memo { get; set; }

Property Value

Type	Description
string

MetadataEndorsement

Changes the administrator key for updating metadata associated with tokens and assets.

Declaration

public Endorsement? MetadataEndorsement { get; set; }

Property Value

Type	Description
Endorsement

Name

If specified, replaces the current name of this token with the new name.

Declaration

public string? Name { get; set; }

Property Value

Type	Description
string

PauseEndorsement

Changes the administrator key for signing transactions that can pause or continue the exchange of all assets across all accounts on the network.

Declaration

public Endorsement? PauseEndorsement { get; set; }

Property Value

Type	Description
Endorsement

RenewAccount

If specified, updates the address of the account supporting the auto 
renewal of the token at expiration time.  The token lifetime will be
extended by the RenewPeriod at expiration time if this account
contains sufficient funds.  The private key associated with
this account must sign the transaction if RenewAccount is
specified.  Setting the value to 

EntityId.None

clears the renewal account.

Declaration

public EntityId? RenewAccount { get; set; }

Property Value

Type	Description
EntityId

RenewPeriod

If specified, update the interval of the token and auto-renewal period. If the associated renewal account does not have sufficient funds to renew at the expiration time, it will be renewed for a period of time the remaining funds can support. If no funds remain, the token instance will be deleted.

Declaration

public TimeSpan? RenewPeriod { get; set; }

Property Value

Type	Description
TimeSpan?

RoyaltiesEndorsement

Changes the administrator key for signing transactions updating the royalties (custom transfer fees) associated with this token.

Declaration

public Endorsement? RoyaltiesEndorsement { get; set; }

Property Value

Type	Description
Endorsement

Signatory

Additional private key, keys or signing callback method required to authorize the update. Typically matches the administrative Endorsement associated with the token if it is not already the same as the payer for the transaction.

Declaration

public Signatory? Signatory { get; set; }

Property Value

Type	Description
Signatory

Remarks

Keys/callbacks added here will be combined with those already identified in the client object's context when signing this transaction to change the state of this account.

SupplyEndorsement

Changes the administrator key for signing transactions for minting or unminting tokens in the treasury account.

Declaration

public Endorsement? SupplyEndorsement { get; set; }

Property Value

Type	Description
Endorsement

SuspendEndorsement

Changes the administrator key for signing transactions for freezing or unfreezing an account's ability to transfer tokens.

Declaration

public Endorsement? SuspendEndorsement { get; set; }

Property Value

Type	Description
Endorsement

Symbol

If specified, replaces the current symbol for this token with the new Symbol.

Declaration

public string? Symbol { get; set; }

Property Value

Type	Description
string

Token

The identifier of the token to update.

Declaration

public EntityId Token { get; set; }

Property Value

Type	Description
EntityId

Treasury

If specified, changes the treasury account holding the reserve balance of tokens.

Declaration

public EntityId? Treasury { get; set; }

Property Value

Type	Description
EntityId