Skip to main content

Interface: CreateCollectionRequest

Request object to create a collection.

Properties​

access​

• access: 0 | 1 | 2 | 3 | 4

Access type of the collection

accessAwards​

• Optional accessAwards: any[]

Build5 id of awards. If set, only members having the specified awards can access this collection.

accessCollections​

• Optional accessCollections: any[]

Build5 id of collections. If set, only members owning NFTs from the specified collection can access this collection.

availableFrom​

• Optional availableFrom: Date

The collections available from data. It can be maximum 10 minutes in the past.

bannerUrl​

• Optional bannerUrl: string

Banner ulr.

category​

• category: "COLLECTIBLE" | "PFP" | "PHOTOGRAPHY" | "ANIMATION" | "GENERATIVE" | "SINGLE" | "INTERACTIVE" | "ABSTRACT" | "PIXELART" | "GAME" | "ART" | "THREE_D"

Category of the collection.

description​

• description: string

Description of the collection.

discord​

• Optional discord: string

Discord url of the collection.

discounts​

• Optional discounts: { amount: number ; tokenReward: number ; tokenSymbol: string }[]

Array of discounts. Minimum 0, maximum 5.

limitedEdition​

• Optional limitedEdition: boolean

If true, the collection is limited, it can have a limited number of NFTs.

name​

• name: string

Name of the collection.

onePerMemberOnly​

• Optional onePerMemberOnly: boolean

If true, only on NFT can be owned per member from this collection.

placeholderUrl​

• Optional placeholderUrl: string

Placeholder url.

price​

• price: number

Price of the collection. Minimum 1000000, maximum 1000000000000.

royaltiesFee​

• royaltiesFee: number

Royalty fee for the collection. Minimum 0, maximum 1

royaltiesSpace​

• Optional royaltiesSpace: string

Build5 id of the royalty space.

space​

• Optional space: string

Build5 id of the space for this collection.

twitter​

• Optional twitter: string

Twitter url of the collection.

type​

• type: 0 | 1 | 2

Type of the collection.

url​

• Optional url: string

Url for the collection.