PATCH
/
2022-06-09
/
collections
/
{collectionId}
curl --request PATCH \
  --url https://staging.crossmint.com/api/2022-06-09/collections/{collectionId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "payments": {
    "price": "<string>",
    "recipientAddress": "<string>"
  },
  "supplyLimit": 123
}'
{
  "action": "collections.update",
  "actionId": "e9abb61c-9371-447e-af1a-86fb5c073754",
  "data": {
    "chain": "arbitrum",
    "changes": "supplyLimit",
    "collection": {
      "contractAddress": "0x45ba91BCa91fA0D384022d3C279866811795FcF7",
      "id": "42c43e55-f92d-4b25-bc99-d8309b6e1f38"
    }
  },
  "resource": "https://staging.crossmint.com/api/2022-06-09/collections/<collectionId>",
  "startedAt": "2023-12-30T00:06:56.000Z",
  "status": "pending"
}

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
payments
object

Enable payments for this collection by setting price and recipientAddress

supplyLimit
number

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

Response

200 - application/json
action
string
actionId
string
data
object
resource
string
startedAt
string
status
string