Set pre-auction configuration

Sets the validated tenant’s configuration. An unchanged configuration records no new version. X-Idempotency is required: the same key and body replay; another body is refused. A body without fechamento and rodizio stores closing by deadline and no rodizio. Active configuration requires the worker; a preferred fund must be registered, and inactive funds are accepted.

PUT /v1/consignado/preleilao/config

Set pre-auction configuration

cURL

curl --request PUT \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/consignado/preleilao/config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "ativo": false,
  "criterio": "cet_anual",
  "janelaSegundos": 600,
  "fechamento": "todos_responderam",
  "fundoPreferidoRef": "fundo-a",
  "rodizio": {
    "faixaCetMensalBps": 15
  }
}
'

200

{
  "ativo": true,
  "configured": true,
  "criterio": "cet_anual",
  "fechamento": "prazo",
  "janelaSegundos": 600,
  "rodizio": {
    "faixaCetMensalBps": 15
  },
  "sequence": 3,
  "changedAt": "2026-11-03T15:00:00Z",
  "changedBy": "user-123",
  "fundoPreferidoRef": "fundo-a"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency · string · requerido

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

Required string length: 1 - 128

Ejemplo:

"idem-preleilao-0001"

Cuerpo

application/json

ativo · boolean · requerido

Whether the pre-auction is active.

Ejemplo:

false

criterio · enum<string> · requerido

Selection criterion.

Opciones disponibles: cet_anual, parcela, prazo

Ejemplo:

"cet_anual"

janelaSegundos · integer<int64> · requerido

Quote window in seconds.

Rango requerido: 60 <= x <= 14400

Ejemplo:

600

fechamento · enum<string> · predeterminado: prazo

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

Opciones disponibles: prazo, todos_responderam

Ejemplo:

"todos_responderam"

fundoPreferidoRef · string

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

Maximum string length: 128

Pattern: ^[^]*$

Ejemplo:

"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.

Show child attributes

Respuesta

200

application/json

OK

ativo · boolean · requerido

Whether the pre-auction is active.

Ejemplo:

true

configured · boolean · requerido

Whether configuration exists.

Ejemplo:

true

criterio · string · requerido

Selection criterion, empty when unconfigured.

Ejemplo:

"cet_anual"

fechamento · string · requerido

Closing mode, empty when unconfigured.

Ejemplo:

"prazo"

janelaSegundos · integer<int64> · requerido

Quote window in seconds.

Ejemplo:

600

rodizio · object | null · requerido

Rodizio settings; null when the rodizio is off.

Show child attributes

sequence · integer<int64> · requerido

Configuration version.

Ejemplo:

3

changedAt · string<date-time>

Last change time.

Ejemplo:

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

changedBy · string

Actor who changed the configuration.

Ejemplo:

"user-123"

fundoPreferidoRef · string

Preferred fund, when configured.

Ejemplo:

"fundo-a"