Skip to main content
POST
Give out a paddle

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

Either a person you already hold, or a name and an email to make one from.

person_id
string

Somebody already on your people list.

name
string

Used with email when the bidder is new.

email
string

Where outbid notices go. Matched to an existing person when it is one you hold.

Response

They already had a paddle.

id
string
person_id
string
paddle_number
integer

Numbered from 1 within the auction.

name
string
email
string | null
registered_at
string
leading
integer

How many lots they are currently holding.

bids
integer
bid_token
string

What the bidder bids with on your public auction page. Returned here and nowhere else: it is a credential for this one auction, and the bidders list never carries it.

existing
boolean

True when they already had a paddle. Registering twice is not an error; the paddle they hold comes back.