NFT Collections

Set Transferability

Update the transferable status of a collection.

This API is supported on EVM and Aptos chains. You must contact sales to gain access to this API.

API scope required: collections.update

put/v1-alpha1/minting/collections/{collectionId}/transferable

Request

Base URL
https://staging.crossmint.com/api
Auth
none required
TypeScript
https://skmtc.dev/crossmint/apis/onramp/docs/v1-alpha1/minting/collections/:collectionId/transferable/put.ts
A function with typed inputs. Its response is checked against the schema.

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

valueboolean required

Toggles the transferability of NFTs within the collection. Set to false to disable transfers.

{
  "value": true
}

Success

No recorded changes to this operation across all 1 revision of this API.