POST
/
2022-06-09
/
collections
/
{collectionId}
/
sfts
curl --request POST \
  --url https://staging.crossmint.com/api/2022-06-09/collections/{collectionId}/sfts \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "templateId": "silver-pass",
  "recipient": "email:testy@crossmint.io:polygon",
  "amount": 10
}'
{
  "actionId": "a91c15e3-60f2-4a45-bf1a-cee508981667",
  "action": "nfts.create",
  "status": "pending",
  "data": {
    "chain": "polygon",
    "collection": {
      "id": "84e3d617-9c1b-4e7a-9686-522a9ea7c520",
      "contractAddress": 8.879871515446455e+47
    },
    "recipient": {
      "walletAddress": 1.1866673241372808e+48,
      "email": "testy@crossmint.io"
    },
    "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"
}

Authorizations

X-API-KEY
string
headerrequired

Obtained in the Crossmint developer console

Headers

x-idempotency-key
string

Unique identifier to prevent duplicate requests

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 intitial request. Example: your-custom-identifer

Body

application/json
templateId
string
required

Identifier of the template

recipient
string
required

Allowed formats:

<chain>:<address> or

email:<email_address>:<chain> or

userId:<userId>:<chain>

see here for more info

amount
integer

(Optional) Amount to mint

Response

200 - application/json
actionId
string
action
string
status
string
data
object
startedAt
string
resource
string
Mint NFT with IDGet All NFTs