Skip to main content
PUT
Set pre-auction configuration

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

Required key; the same body replays, a different body is refused.

Required string length: 1 - 128
Example:

"idem-preleilao-0001"

Body

application/json
ativo
boolean
required

Whether the pre-auction is active.

Example:

false

criterio
enum<string>
required

Selection criterion.

Available options:
cet_anual,
parcela,
prazo
Example:

"cet_anual"

janelaSegundos
integer<int64>
required

Quote window in seconds.

Required range: 60 <= x <= 14400
Example:

600

fechamento
enum<string>
default:prazo

When the auction closes: at the window deadline, or earlier once every participant answered.

Available options:
prazo,
todos_responderam
Example:

"todos_responderam"

fundoPreferidoRef
string

Optional registered fund, preserved byte for byte; inactive funds are accepted.

Maximum string length: 128
Pattern: ^[^]*$
Example:

"fundo-a"

rodizio
object | null

Absent or null turns the rodizio off; present turns on the deficit rodizio over the value released in the local day, with no algorithm choice.

Response

OK

ativo
boolean
required

Whether the pre-auction is active.

Example:

true

configured
boolean
required

Whether configuration exists.

Example:

true

criterio
string
required

Selection criterion, empty when unconfigured.

Example:

"cet_anual"

fechamento
string
required

Closing mode, empty when unconfigured.

Example:

"prazo"

janelaSegundos
integer<int64>
required

Quote window in seconds.

Example:

600

rodizio
object | null
required

Rodizio settings; null when the rodizio is off.

sequence
integer<int64>
required

Configuration version.

Example:

3

changedAt
string<date-time>

Last change time.

Example:

"2026-11-03T15:00:00Z"

changedBy
string

Actor who changed the configuration.

Example:

"user-123"

fundoPreferidoRef
string

Preferred fund, when configured.

Example:

"fundo-a"