Replace the holidays of a year (editor; audited)

Replaces the full national bank holiday calendar of a year. A loaded year covers every date in it. On a holiday there is no operating window (transfer creation responds 422 TED-0021). On a date whose year is not loaded, the window is undetermined (503 TED-0022). An empty list removes the year.

Load the next year before 1 December. A repeat call with the same dates is harmless. A transfer on a date of a year that is not loaded responds 503 TED-0022 with this detail: “The holiday calendar has no entries for the year of the requested date. Load that year with PUT /v1/policy/holidays.” The next request after the load is accepted, with no restart.

All dates must belong to the year you send. The change is audited. Editor operation. Requires X-Idempotency.

If the audit trail cannot record the change, TED Lerian refuses it with 503 TED-9002 and changes nothing: only the audit trail keeps the previous value. Reads stay available.

PUT /v1/policy/holidays

Replace the holidays of a year (editor; audited)

cURL

curl --request PUT \
  --url https://api.example.com/v1/policy/holidays \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "holidays": [
    {
      "date": "2026-01-01",
      "name": "Confraternização Universal",
      "scope": "NATIONAL"
    },
    {
      "date": "2026-04-21",
      "name": "Tiradentes",
      "scope": "NATIONAL"
    },
    {
      "date": "2026-12-25",
      "name": "Natal",
      "scope": "NATIONAL"
    }
  ],
  "year": 2026
}
'

200

{
  "holidays": [
    {
      "date": "2026-01-01",
      "name": "Confraternização Universal",
      "scope": "NATIONAL"
    },
    {
      "date": "2026-04-21",
      "name": "Tiradentes",
      "scope": "NATIONAL"
    },
    {
      "date": "2026-12-25",
      "name": "Natal",
      "scope": "NATIONAL"
    }
  ],
  "updatedAt": "2026-10-22T12:00:00Z",
  "year": 2026
}

Autorizações

Authorization · string · header · obrigatório

JWT token that the Lerian Access Manager issues for your institution. Send it in Authorization: Bearer <token> on every call (except the public health probes). The tenant never comes from the body, the query, or the path. Each operation requires a role with the matching permission (see the API overview). Without it, 403 TED-0071. Missing, invalid, or expired token: 401 TED-0070.

Cabeçalhos

X-TTL · integer

Replay window of the idempotency key, in seconds. Default 300 (5 minutes) when missing or invalid; values outside 30 s to 7 days are adjusted to these limits. Only the value of the FIRST request for a key counts. A change to X-TTL on retries has no effect. Within the window, the original response is replayed byte for byte.

Intervalo obrigatório: x >= 1

X-Idempotency · string · obrigatório

Idempotency key that the integrator creates (1 to 128 printable ASCII characters, no spaces; we recommend a UUID). Required on every operation with an effect. Send the SAME key again when you retry a call that failed because of a timeout or network error. Same key + same body returns the original response with X-Idempotency-Replayed: true and no new effect. Same key + different body responds 422 TED-0012. Same key still in processing responds 409 TED-0013 (retry after Retry-After). Missing or in the wrong format: 400 TED-0011.

X-Request-Id · string<uuid>

Correlation identifier of this request (UUID). Optional: when you omit it, or when the value is not a well-formed UUID, the platform creates a UUID and returns it in the X-Request-Id header of the response. The resolved identifier goes to the logs, spans, and audit events of this request. Keep it to open a support ticket.

Corpo

application/json

National bank holiday calendar of a year. On a holiday there is no operating window.

holidays · object[] | null · obrigatório

Full list of holidays for the year — the operation replaces the previous list.

Show child attributes

year · integer<int64> · obrigatório

Year of the calendar. All dates must belong to it.

Intervalo obrigatório: 2000 <= x <= 2100

updatedAt · string<date-time>

Instant (UTC) of the last write. Ignored on write.

Resposta

200

application/json

Calendar of the year replaced and audited. The body returns the current calendar.

National bank holiday calendar of a year. On a holiday there is no operating window.

holidays · object[] | null · obrigatório

Full list of holidays for the year — the operation replaces the previous list.

Show child attributes

year · integer<int64> · obrigatório

Year of the calendar. All dates must belong to it.

Intervalo obrigatório: 2000 <= x <= 2100

updatedAt · string<date-time>

Instant (UTC) of the last write. Ignored on write.