Sign in

v1

latestOpenAPI 3.0.12026-07-2699111970.1 KB
NFTs

Mint SFT

Mint your SFTs and deliver them to a web3 wallet or an email address

API scope required: nfts.create

post/2022-06-09/collections/{collectionId}/sfts

Path parameters

collectionIdstring 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

Headers

x-idempotency-keystring

Unique identifier to prevent duplicate requests

Request body

templateIdstring required

Identifier of the template

recipientstring required

Allowed formats:

<chain>:<address> or

email:<email_address>:<chain> or

userId:<userId>:<chain> or

twitter:<twitter_handle>:<chain>

see here for more info

sendNotificationboolean

Notify recipient via email notification about successful mint [Default: true]. For legacy projects created before Sep 16, 2024, this is set to false by default.

localestring

Specify the locale for the email content [Default: en-US]

amountinteger

(Optional) Amount to mint

Example request

{
  "templateId": "silver-pass",
  "recipient": "email:testy@crossmint.com:polygon",
  "locale": "en-US",
  "amount": 10
}

Response

Success

actionIdstring
actionstring
statusstring
startedAtstring
resourcestring

Example response

{
  "actionId": "a91c15e3-60f2-4a45-bf1a-cee508981667",
  "action": "nfts.create",
  "status": "pending",
  "data": {
    "chain": "polygon",
    "collection": {
      "id": "84e3d617-9c1b-4e7a-9686-522a9ea7c520",
      "contractAddress": "0x9b8ab8949bd7E73E61945b88F7fe12151f98ad3C"
    },
    "recipient": {
      "walletAddress": "0xcFDc00Cf926A5053f9Cdf004e6DF17e6dEB2E146",
      "email": "testy@crossmint.com"
    },
    "token": {
      "id": "a91c15e3-60f2-4a45-bf1a-cee508981667"
    }
  },
  "startedAt": "2024-01-02T22:05:01.000Z",
  "resource": "https://staging.crossmint.com/api/2022-06-09/actions/a91c15e3-60f2-4a45-bf1a-cee508981667"
}