PUT
/
2022-06-09
/
collections
/
{collectionId}
curl --request PUT \
  --url https://staging.crossmint.com/api/2022-06-09/collections/{collectionId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "chain": "polygon",
  "metadata": {
    "name": "Sample NFT Collection",
    "imageUrl": "https://www.crossmint.com/assets/crossmint/logo.png",
    "description": "This is a sample NFT collection",
    "symbol": "TOKEN"
  },
  "fungibility": "non-fungible",
  "transferable": true,
  "supplyLimit": 123,
  "payments": {
    "price": "<string>",
    "recipientAddress": "<string>",
    "currency": "<string>"
  },
  "subscription": {
    "enabled": false
  },
  "reuploadLinkedFiles": true
}'
{
  "id": "5263650e-6d43-4ed3-9e31-0cf593d076a4",
  "metadata": {
    "name": "Sample NFT Collection",
    "description": "This is a sample NFT collection",
    "imageUrl": "https://www.crossmint.com/assets/crossmint/logo.png",
    "symbol": "TOKEN"
  },
  "fungibility": "non-fungible",
  "onChain": {
    "chain": "polygon",
    "type": "erc-721"
  },
  "actionId": "5263650e-6d43-4ed3-9e31-0cf593d076a4",
  "subscription": {
    "enabled": true
  }
}

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

Body

application/json

Response

200
application/json
Success.

The response is of type object.