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

This is an alpha API and subject to change.

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

value

boolean

required

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