API Mutations Glossary

Explore further about the Enjin Platform mutations.

The Enjin Platform API offers a variety of mutations that enable users to add information to the blockchain. Built on top of GraphQL, these mutations make it simpler to engage with blockchain collections, even for those without expertise in blockchain programming.
The Enjin Platform API mutations are organized into categories for collections, users, wallets, and miscellaneous. The following tables present all these mutations, which can also be found in the GraphiQL schema when accessing your environment through the query & mutation builder.
Enjin Platform mutations
Here's a table with all the mutations and their descriptions
Mutation Name
Mutation Description
ApproveCollection
Approve another account to transfer any tokens from a collection account. You can also specify a block number where this approval will expire.
ApproveToken
Approve another account to make transfers from a token account. You can also specify a block number where this approval will expire and the amount of tokens this account will be able to transfer.
BatchMint
Use this method to batch together several mints into one transaction. You can mix and match Create Token and Mint Token params, as well as use the continueOnFailure flag to skip mints which fail on chain so they can be fixed later.
BatchSetAttribute
Use this to set multiple attributes on a collection or token in one transaction. Setting the continueOnFailure flag to true will allow all valid attributes to be set while skipping invalid attributes so they can be fixed and attempted again in another transaction.
BatchTransfer
Use this method to transfer multiple tokens in one transaction. You can include up to 250 different transfers per batch. Set the continueOnFailure to true to allow all valid transfers to complete while skipping transfers which would fail so they can be fixed and attempted again in another transaction.
Burn
Deletes a collection and get its reserved value back. You can only destroy a collection after all tokens have been burned.
CreateCollection
Creates a new on-chain collection. The new collection ID will be returned in the transaction events after being finalized on-chain.
CreateToken
Creates a new token in a collection. The new token will be automatically transferred to the specified recipient account.
DestroyCollection
Deletes a collection and get its reserved value back. You can only destroy a collection after all tokens have been burned.
Freeze
Freezes a collection, token, collection account or token account. Tokens cannot be transferred or burned if they are frozen. Freezing a collection or collection account will freeze all the tokens in it.
MintToken
Mint more of an existing token. This only applies to tokens which have a supply cap greater than 1.
MutateCollection
Changes collection default values.
MutateToken
Changes token default values.
OperatorTransferToken
Transfer tokens as the operator of someone else's wallet. Operator transfers are transfers that you make using tokens from somebody else's wallet as the source. To make this type of transfer the source wallet owner must approve you for transferring their tokens.
RemoveAllAttributes
Removes all attributes from the given collection ID and token ID.
RemoveCollectionAttribute
Remove an attribute from the specified collection.
RemoveTokenAttribute
Remove an attribute from the specified token.
Enjin Platform Beam package mutations
Mutation Name
Description
ClaimBeam
Mutation for claiming a beam.
CreateBeam
Mutation for creating a beam.
DeleteBeam
Mutation for deleting a beam.
ExpireSingleUseCodes
Expire single use codes.
UpdateBeam
Mutation for updating a beam.
Fuel Tanks package mutations
Mutation Name
Description
AddAccount
Adds new account to the fuel tank.
BatchAddAccount
Adds new account to the fuel tank in batch.
BatchRemoveAccount
Removes an account from the fuel tank in batch.
CreateFuelTank
Creates a fuel tank.
DestroyFuelTank
Destroy the fuel tank.
DispatchAndTouch
Same as 'Dispatch', but creates an account for 'origin' if doesn't exist.
Dispatch
Dispatch a call using the 'tankId' subject to the rules of 'ruleSetId'.
SetConsumption
Force set the fuel tank consumption.
InsertRuleSet
Insert a new rule set for the fuel tank.
MutateFuelTank
Apply 'mutation' to a fuel tank.
RemoveAccount
Removes an account from the fuel tank.
RemoveAccountRuleData
Remove account rule from fuel tank.
RemoveRuleSet
Remove a rule set from the fuel tank.
ScheduleMutateFreezeState
Schedule mutating of 'is_frozen' state that determines if the fuel tank or rule set can be frozen.
Marketplace package mutations
Mutation Name
Description
CancelListing
Cancels the listing.
CreateListing
Places a sell order.
FillListing
Fills a fixed price listing.
FinalizeAuction
This will end the auction and transfer funds.
PlaceBid
Places a bid on a listing. The listing must be an auction.

Mutation Name	Mutation Description
ApproveCollection	Approve another account to transfer any tokens from a collection account. You can also specify a block number where this approval will expire.
ApproveToken	Approve another account to make transfers from a token account. You can also specify a block number where this approval will expire and the amount of tokens this account will be able to transfer.
BatchMint	Use this method to batch together several mints into one transaction. You can mix and match Create Token and Mint Token params, as well as use the continueOnFailure flag to skip mints which fail on chain so they can be fixed later.
BatchSetAttribute	Use this to set multiple attributes on a collection or token in one transaction. Setting the continueOnFailure flag to true will allow all valid attributes to be set while skipping invalid attributes so they can be fixed and attempted again in another transaction.
BatchTransfer	Use this method to transfer multiple tokens in one transaction. You can include up to 250 different transfers per batch. Set the continueOnFailure to true to allow all valid transfers to complete while skipping transfers which would fail so they can be fixed and attempted again in another transaction.
Burn	Deletes a collection and get its reserved value back. You can only destroy a collection after all tokens have been burned.
CreateCollection	Creates a new on-chain collection. The new collection ID will be returned in the transaction events after being finalized on-chain.
CreateToken	Creates a new token in a collection. The new token will be automatically transferred to the specified recipient account.
DestroyCollection	Deletes a collection and get its reserved value back. You can only destroy a collection after all tokens have been burned.
Freeze	Freezes a collection, token, collection account or token account. Tokens cannot be transferred or burned if they are frozen. Freezing a collection or collection account will freeze all the tokens in it.
MintToken	Mint more of an existing token. This only applies to tokens which have a supply cap greater than 1.
MutateCollection	Changes collection default values.
MutateToken	Changes token default values.
OperatorTransferToken	Transfer tokens as the operator of someone else's wallet. Operator transfers are transfers that you make using tokens from somebody else's wallet as the source. To make this type of transfer the source wallet owner must approve you for transferring their tokens.
RemoveAllAttributes	Removes all attributes from the given collection ID and token ID.
RemoveCollectionAttribute	Remove an attribute from the specified collection.
RemoveTokenAttribute	Remove an attribute from the specified token.

Mutation Name	Description
ClaimBeam	Mutation for claiming a beam.
CreateBeam	Mutation for creating a beam.
DeleteBeam	Mutation for deleting a beam.
ExpireSingleUseCodes	Expire single use codes.
UpdateBeam	Mutation for updating a beam.

Mutation Name	Description
AddAccount	Adds new account to the fuel tank.
BatchAddAccount	Adds new account to the fuel tank in batch.
BatchRemoveAccount	Removes an account from the fuel tank in batch.
CreateFuelTank	Creates a fuel tank.
DestroyFuelTank	Destroy the fuel tank.
DispatchAndTouch	Same as 'Dispatch', but creates an account for 'origin' if doesn't exist.
Dispatch	Dispatch a call using the 'tankId' subject to the rules of 'ruleSetId'.
SetConsumption	Force set the fuel tank consumption.
InsertRuleSet	Insert a new rule set for the fuel tank.
MutateFuelTank	Apply 'mutation' to a fuel tank.
RemoveAccount	Removes an account from the fuel tank.
RemoveAccountRuleData	Remove account rule from fuel tank.
RemoveRuleSet	Remove a rule set from the fuel tank.
ScheduleMutateFreezeState	Schedule mutating of 'is_frozen' state that determines if the fuel tank or rule set can be frozen.

Mutation Name	Description
CancelListing	Cancels the listing.
CreateListing	Places a sell order.
FillListing	Fills a fixed price listing.
FinalizeAuction	This will end the auction and transfer funds.
PlaceBid	Places a bid on a listing. The listing must be an auction.

API Queries Glossary

Enjin Platform API Core Package

Last modified 22d ago