Skip to main content
POST
Record a contingency schedule change

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

Idempotency key for this state-changing request (required, max 255 characters).

Maximum string length: 255

Body

application/json
effectiveAt
string<date-time>
required

The announced instant the change takes effect (RFC3339); with windowSeq, the announced new deposit close, which moves that window's WINDOW_CLOSING deadline and must fall on the window's São Paulo date, no earlier than it opens (else 422; record a close after midnight without windowSeq).

origin
string
required

The announcing channel / upstream reference (non-empty, ≤256 chars).

Maximum string length: 256
reason
string
required

Why the schedule changed (non-empty, ≤500 chars).

Maximum string length: 500
windowSeq
integer<int64>

The affected canonical window's grid sequence; omit for a non-window-specific note. Validated against the compiled window grid.

Required range: x >= 1

Response

Created

announcedAt
string<date-time>
required

When the change was recorded (intake instant).

effectiveAt
string<date-time>
required

The announced instant the change takes effect, recorded verbatim (for a window prorrogação, the announced new close).

id
string<uuid>
required

Schedule change id.

origin
string
required

Auditable origin — the announcing channel / upstream reference (e.g. "Núclea e-mail ref X").

reason
string
required

Why the schedule changed, as recorded by the operator.

windowSeq
integer<int64>

The affected canonical window's grid sequence; omitted for a non-window-specific note.