Set Royalties

Configure royalties for all NFTs in a collection.

This API is only supported for EVM chains and implements the EIP-2981 standard.

API scope required: collections.update

This is an alpha API and subject to change.

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

recipients

object[]

List of royalty recipients. Note: EVM collections only support a single recipient. Use a contract splitter as recipient in order to send payments to multiple addresses.

Show child attributes

recipients.address

string

Address where the payments will be received. Note: ENS addresses are not supported.

recipients.basisPoints

integer

Percentage of the sale price that will go to the recipient address. A basis point is a standard measure for percentages in finance. One basis point equals 1/100th of 1%, or 0.01%.