Add a sale to a collection

POST

/collection/{highlightId}/sales

Add a new sale to a collection. Draft collections can have one sale at a time. For live collections, gated sales go live immediately; public sales return a contract execution for on-chain registration.

Authorizations

• bearerAuth

Parameters

Path Parameters

highlightId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Body ^required

object

name

Any of:

string

string

>= 1 characters

null

null

type

required

string

Allowed values: FIXED_PRICE DUTCH_AUCTION RANKED_AUCTION CUSTOM

startAt

required

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/

endAt

Any of:

string

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/

null

null

price

required

string

>= 1 characters

currency

required

string

>= 1 characters

maxPerTransaction

required

integer

<= 9007199254740991

maxPerWallet

required

integer

<= 9007199254740991

maxTotal

required

integer

<= 9007199254740991

paymentRecipient

required

string

>= 1 characters

accessMode

string

Allowed values: PUBLIC GATED

gateId

Any of:

string

string

>= 1 characters

null

null

gasSponsored

boolean

mechanicId

Any of:

string

string

>= 1 characters

null

null

typeConfig

Any of:

unknown

null

null

collectorMessage

Any of:

string

string

>= 1 characters

null

null

customMintFee

Any of:

string

string

>= 1 characters

null

null

Responses

200

Sale added

object

saleId

required

string

status

required

string

Allowed values: Draft Live

contractExecution

required

Any of:

object

object

chainId

required

integer

> 0 <= 9007199254740991

to

required

Any of:

string

string

null

null

data

required

string

value

required

string

null

null

400

Invalid request

401

Unauthorized

403

Forbidden

404

Not found

409

Sale already exists