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 '{
  "supplyLimit": 123,
  "payments": {
    "price": "<string>",
    "recipientAddress": "<string>",
    "currency": "<string>"
  }
}'
{
  "actionId": "e9abb61c-9371-447e-af1a-86fb5c073754",
  "action": "collections.update",
  "status": "pending",
  "data": {
    "chain": "arbitrum",
    "collection": {
      "id": "42c43e55-f92d-4b25-bc99-d8309b6e1f38",
      "contractAddress": "0x45ba91BCa91fA0D384022d3C279866811795FcF7"
    },
    "changes": "supplyLimit"
  },
  "startedAt": "2023-12-30T00:06:56.000Z",
  "resource": "https://staging.crossmint.com/api/2022-06-09/collections/<collectionId>",
  "subscription": {
    "enabled": true
  }
}

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
​
supplyLimit
number

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

​
payments
object

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

Response

200
application/json
A JSON object containing transactionId and status
​
actionId
string
Example:

"e9abb61c-9371-447e-af1a-86fb5c073754"

​
action
string
Example:

"collections.update"

​
status
string
Example:

"pending"

​
data
object
​
startedAt
string
Example:

"2023-12-30T00:06:56.000Z"

​
resource
string
Example:

"https://staging.crossmint.com/api/2022-06-09/collections/<collectionId>"

​
subscription
object