POST
/
2022-06-09
/
collections
/
{collectionId}
/
nfts

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
metadata
required

Optional if baseURI is set.

recipient
string
required

Allowed formats:

<chain>:<address> or

email:<email_address>:<chain> or

userId:<userId>:<chain>

see here for more info

sendNotification
boolean

Notify recipient via email notification about successful mint [Default: true]. Learn how this applies to legacy projects.

locale
string

Specify the locale for the email content [Default: en-US]

reuploadLinkedFiles
boolean

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

compressed
boolean

Solana only Use NFT compression for cheaper mint costs [Default: true]

Response

200 - application/json
id
string
onChain
object
actionId
string
Sign MessageMint NFT with ID