Create Template with ID

Create a token template with preconfigured metadata

API scope required: nfts.create

PUT /2022-06-09/collections/{collectionId}/templates/{templateId}

Create Template with ID

cURL

curl --request PUT \
  --url https://staging.crossmint.com/api/2022-06-09/collections/{collectionId}/templates/{templateId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "metadata": {
    "name": "My template",
    "image": "https://www.crossmint.com/assets/crossmint/logo.png",
    "description": "A new collection with its own dedicated smart contract",
    "symbol": "<string>"
  },
  "onChain": {
    "tokenId": "1"
  },
  "supply": {
    "limit": 10
  },
  "reuploadLinkedFiles": true
}
'

200

{
  "templateId": "20ed0963-0185-49af-b4a0-2de3169bb367",
  "metadata": {
    "name": "My Token",
    "image": "ipfs://QmaToZn4VEjF7q4CAudPaNka6AD484xuuEZSXmTLJPDLVE",
    "description": "Sample Token Template",
    "symbol": "A shorthand identifier for the token (Solana only)"
  },
  "onChain": {
    "tokenId": 1
  },
  "supply": {
    "limit": 1,
    "minted": 0
  }
}

Authorizations

X-API-KEY · string · header · required

Obtained in the Crossmint developer console

Path Parameters

collectionId · string · required

This is the identifier for the collection related to the request. Every project has default collections: default-solana and default-polygon.

The create-collection API will result in collections with UUID formatted collectionId. Example: 9c82ef99-617f-497d-9abb-fd355291681b

The create-collection-idempotent API allows you to specify an arbitrary identifier during the initial request. Example: your-custom-identifier

templateId · string · required

The template ID

Body

application/json

metadata · object

See https://docs.crossmint.com/docs/metadata for more info

Show child attributes

onChain · object

Onchain details

Show child attributes

supply · object

Supply details

Show child attributes

reuploadLinkedFiles · boolean

Any URLs in the metadata object will be resolved and reuploaded to IPFS [Default: true]

Response

200

application/json

Success

templateId · string<uuid>

Example:

"20ed0963-0185-49af-b4a0-2de3169bb367"

metadata · object

Show child attributes

onChain · EVM · object

EVM

Solana

Show child attributes

supply · object

Show child attributes