CreateTokenTypeRequest

Object reference for creating a token-template

 {
    "fungible": true,
    "burnable": true,
    "name": "string",
    "description": "string",
    "image": "string",
    "externalUrl": "string",
    "backgroundColor": "string",
    "animationUrls": [
      {
        "type": "string",
        "value": "string"
      }
    ],
    "maxSupply": 0,
    "attributes": [
      {
        "type": "string",
        "name": "string",
        "value": "string",
        "maxValue": "string"
      }
    ],
    "destinations": [
      {
        "address": "string",
        "amount": 0
      }
    ],
    "storage": {
      "type": "CUSTOM",
      "location": "string"
    }
  }
Parameters
Parameter
Required
Type
Description
fungible
false
Boolean
Determines if the NFTs from this template will be minted as fungible/non fungible.
If missing it defaults to false.
burnable
false
Boolean
Determines if the NFTs from this template will be burnable.
If missing it defaults to false.
name
true
String
Name of the NFTs that will be created from this template
description
false
String
Description of the NFTs that will be created from this template
image
false
String
Image of the NFTs that will be created from this template
externalUrl
false
String
External URL of the NFTs that will be created from this template.
backgroundColor
false
String
Bg color of the NFTs that will be created from this template.
animationUrls
false
array
Array of animation URL for the NFTs that will be created from this template.
animationUrls.type
true
String
Type of the animation URL.
animationUrls.value
true
String
Value of the animation URL.
maxSupply
false
String
Max Supply for NFTs created by this template.
attributes
false
array
Attributes of this NFT template.
attributes.type
true
String
Can be one of: property|stat|boost|system
attribute.name
true
String
Name of the attribute.
attribute.value
true
String
Value of the attribute.
attribute.maxValue
true
String
Max value for the attribute.
destinations
false
array
If an array of destinations is present, tokens for this token template will be minted and transferred to the destination addresses accordingly.
destinations.address
true
Address
Address of the destination wallet where minted tokens will be sent.
destinations.amount
true
Integer
Amount of tokens to be minted and sent to specified wallet address.
storage
false
Object
Determines the storage of metadata.
If missing, metadata will be stored in our cloud.
storage.type
true
enum
Can be one of: cloud | ipfs | custom.

cloud: We store metadata in our cloud.
ipfs: metadata will be stored in ipfs.
custom: You determine where you will store the metadata for this NFT template.
storage.location
false
String
Location of the NFT metadata. This property is mandatory only if storage.type is set to custom.

Parameter	Required	Type	Description
fungible	false	Boolean	Determines if the NFTs from this template will be minted as fungible/non fungible. If missing it defaults to false.
burnable	false	Boolean	Determines if the NFTs from this template will be burnable. If missing it defaults to false.
name	true	String	Name of the NFTs that will be created from this template
description	false	String	Description of the NFTs that will be created from this template
image	false	String	Image of the NFTs that will be created from this template
externalUrl	false	String	External URL of the NFTs that will be created from this template.
backgroundColor	false	String	Bg color of the NFTs that will be created from this template.
animationUrls	false	array	Array of animation URL for the NFTs that will be created from this template.
animationUrls.type	true	String	Type of the animation URL.
animationUrls.value	true	String	Value of the animation URL.
maxSupply	false	String	Max Supply for NFTs created by this template.
attributes	false	array	Attributes of this NFT template.
attributes.type	true	String	Can be one of: `property\|stat\|boost\|system`
attribute.name	true	String	Name of the attribute.
attribute.value	true	String	Value of the attribute.
attribute.maxValue	true	String	Max value for the attribute.
destinations	false	array	If an array of destinations is present, tokens for this token template will be minted and transferred to the destination addresses accordingly.
destinations.address	true	Address	Address of the destination wallet where minted tokens will be sent.
destinations.amount	true	Integer	Amount of tokens to be minted and sent to specified wallet address.
storage	false	Object	Determines the storage of metadata. If missing, metadata will be stored in our cloud.
storage.type	true	enum	Can be one of: `cloud \| ipfs \| custom.` cloud: We store metadata in our cloud. ipfs: metadata will be stored in ipfs. custom: You determine where you will store the metadata for this NFT template.
storage.location	false	String	Location of the NFT metadata. This property is mandatory only if `storage.type` is set to custom.

Fulfillment States

Last modified 1yr ago