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": "arbitrum",
  "fungibility": "non-fungible",
  "metadata": {
    "description": "This is a sample NFT collection",
    "imageUrl": "https://www.crossmint.com/assets/crossmint/logo.png",
    "name": "Sample NFT Collection",
    "symbol": "XMINT"
  },
  "payments": {
    "price": "<string>",
    "recipientAddress": "<string>"
  },
  "reuploadLinkedFiles": true,
  "supplyLimit": 123
}'
{
  "actionId": "5263650e-6d43-4ed3-9e31-0cf593d076a4",
  "fungibility": "semi-fungible",
  "id": "5263650e-6d43-4ed3-9e31-0cf593d076a4",
  "metadata": {
    "description": "Test",
    "imageUrl": "https://cdn.io/metadata.json",
    "name": "Test Collection",
    "symbol": "XMINT"
  },
  "onChain": {
    "chain": "polygon",
    "type": "erc-1155"
  }
}

Authorizations

X-API-KEY
string
headerrequired

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
chain
enum<string>
required

Blockchain you would like to use for this collection

Available options:
arbitrum,
arbitrum-sepolia,
base,
base-sepolia,
bsc,
optimism,
optimism-sepolia,
polygon,
solana,
zkatana,
zora,
zora-sepolia
fungibility
enum<string>
default: non-fungible

Whether or not this collection is fungible. Only EVM collections may be set as semi-fungible

Available options:
non-fungible,
semi-fungible
metadata
object
required
payments
object

Enable payments for this collection by setting price and recipientAddress

reuploadLinkedFiles
boolean

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

supplyLimit
number

The maximum number of tokens that can be minted for this collection

Response

200 - application/json
actionId
string
fungibility
string
id
string
metadata
object
onChain
object