Skip to main content
POST
Create an auction

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Body

application/json
campaign_id
string
required
name
string
required
description
string | null
opens_at
string | null
closes_at
string | null

Must be after opens_at.

bid_increment_cents
integer

The least a new bid must add to the current one. More than zero.

Response

The auction.

id
string
campaign_id
string
name
string
description
string | null
opens_at
string | null
closes_at
string | null
bid_increment_cents
integer
status
enum<string>

An auction goes one way: draft, open, closed, settled.

Available options:
draft,
open,
closed,
settled
lots
integer

Only on a single read. Counted, never stored.

lots_available
integer

Only on a single read.

opening_total_cents
integer

Only on a single read: every lot's opening bid added up.

created_at
string
updated_at
string