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",
  "fungibility": "non-fungible",
  "supplyLimit": 123,
  "payments": {
    "price": "<string>",
    "recipientAddress": "<string>"
  },
  "reuploadLinkedFiles": true,
  "metadata": {
    "name": "A new collection",
    "imageUrl": "https://www.crossmint.com/assets/crossmint/logo.png",
    "description": "A new collection with its own dedicated smart contract",
    "symbol": "<string>"
  }
}'
This response does not have an example.

Authorizations

X-API-KEY
string
header
required

Path Parameters

collectionId
string
default:
idempotent-collection-name
required

The ID of the named collection, which you will use to create new NFTs and get status

Body

application/json
chain
enum<string>
default:
polygon
required

Blockchain you would like to use for this collection

Available options:
polygon,
solana,
optimism,
arbitrum,
base,
zora,
bsc
metadata
object
required
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
supplyLimit
number

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

payments
object

Enable payments for this collection by setting price and recipientAddress.

reuploadLinkedFiles
boolean

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

Response

200
_mintlify/placeholder

Success.