Pause Token

Pauses all actions of a token minted from a specified contract. The actions of a contract here refer to creating, minting, and sending tokens. You can also "unpause" using Resume Token.

NOTE

Even after pausing the contract, a transaction to send tokens will still return Submitted in the respons, but that doesn't mean that it is actually Committed. To check the transaction status, use Get Contract or Get Token or Wallet API's Check Transaction Status.

Request
Security:
basic
path Parameters
contract-address-or-alias
required
string

Contract address (in hex.) or alias.

token-id
required
string

The ID of the token to pause.

header Parameters
x-chain-id
required
string

Kaia Network Chain ID (1001 or 8217)

x-krn
string

The KRN (KAS Resource Name) unique to an Account Pool

Request Body schema: application/json
any
Responses
200

Your request was successful.

400

The request is not valid.

401

The credential you provided is invalid.

403

Access has been denied.

404

The resource you requested does not exist.

409

There was a conflict with the current state of the server.

post/v2/contract/{contract-address-or-alias}/token/pause/{token-id}
Request samples
application/json
null
Response samples
application/json

Your request was successful.

{
  • "status": "Submitted",
  • "transactionHash": "0xb5a0618be3508b3fe22e35aa96063005dd4c557cf040348cc542b0726cc30f7b"
}