PUT
/
2022-06-09
/
collections
/
{collectionId}

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

Blockchain you would like to use for this collection

Available options:
aptos,
arbitrum,
arbitrum-sepolia,
astar-zkevm,
avalanche,
avalanche-fuji,
base,
base-sepolia,
bsc,
chiliz,
chiliz-spicy-testnet,
ethereum,
ethereum-sepolia,
optimism,
optimism-sepolia,
polygon,
polygon-amoy,
shape,
shape-sepolia,
skale-nebula,
skale-nebula-testnet,
solana,
soneium-minato-testnet,
xai,
xai-sepolia-testnet,
zkyoto,
zora,
zora-sepolia
metadata
object
required
fungibility
enum<string>
default:
non-fungible

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

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

Enable payments for this collection by setting price, recipientAddress and currency

reuploadLinkedFiles
boolean

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

subscription
object
supplyLimit
number

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

transferable
boolean
default:
true

Whether or not NFTs in this collection are transferable. Supported on EVM and Aptos chains. (For subscriptions must be set to false)

Response

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