Skip to main content
PATCH
Change an auction

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The auction's id.

Body

application/json
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
campaign_id
string | null

Move it to another of your campaigns, or null for none.

require_card
boolean
extend_minutes
integer | null

Extended bidding: a bid in a lot's last this-many minutes moves its close to this many minutes after the bid. 1 to 30, or null for none.

extend_cap_minutes
integer

The furthest past its own close a lot can be pushed, in minutes. 1 to 240, at least extend_minutes. 30 unless set.

closing_soon_minutes
integer | null

How many minutes before the close every bidder is told, once, how they stand. 5 to 1440, or null for no notice. 30 unless set; moving the close tells them again.

Response

The auction.

id
string
campaign_id
string | null

The campaign it raises for, or null for an auction on its own.

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
require_card
boolean

Whether a guest bidding on your public site must save a card before bidding.

extend_minutes
integer | null

Extended bidding: a bid in a lot's last this-many minutes moves its close to this many minutes after the bid. 1 to 30, or null for none.

extend_cap_minutes
integer

The furthest past its own close a lot can be pushed, in minutes. 1 to 240, at least extend_minutes. 30 unless set.

closing_soon_minutes
integer | null

How many minutes before the close every bidder is told, once, how they stand. 5 to 1440, or null for no notice. 30 unless set; moving the close tells them again.

closing_soon_sent_at
string | null

When bidders were told it is closing soon.