Sign in

v1

latestOpenAPI 3.0.12026-07-2699111970.1 KB
NFT Collections

Update Collection Info

Update the sales details of a collection

API scope required: collections.update

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

Path parameters

collectionIdstring 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 initial request. Example: your-custom-identifier

Request body

supplyLimitnumber

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

Response

A JSON object containing transactionId and status

actionIdstring
actionstring
statusstring
startedAtstring date-time
resourcestring

Example response

{
  "actionId": "e9abb61c-9371-447e-af1a-86fb5c073754",
  "action": "collections.update",
  "status": "pending",
  "data": {
    "chain": "arbitrum",
    "collection": {
      "id": "42c43e55-f92d-4b25-bc99-d8309b6e1f38",
      "contractAddress": "0x45ba91BCa91fA0D384022d3C279866811795FcF7"
    }
  },
  "startedAt": "2023-12-30T00:06:56.000Z",
  "resource": "https://staging.crossmint.com/api/2022-06-09/collections/<collectionId>"
}