Skip to main content
POST
/
calendarios
/
from-template
Cria calendário pré-populado com feriados nacionais (5 anos) do catálogo central. Se uf for informada, adiciona feriados estaduais daquela UF.
curl --request POST \
  --url https://api.example.com/calendarios/from-template \
  --header 'Content-Type: application/json' \
  --data '
{
  "descricao": "Calendário Goiânia"
}
'
{
  "calendarioId": "f8e0a0f5-4f4d-4b4f-9f8d-8f4d4f4d4f4d",
  "descricao": "Calendário Unidade Goiânia",
  "colaboradores": 7
}

Body

application/json

Nome do calendário e UF opcional (sigla 2 letras)

​
descricao
string
required

Nome do calendário (3 a 150 caracteres)

Example:

"Calendário Goiânia"

​
uf
string

Sigla da UF (2 letras maiúsculas) pra adicionar feriados estaduais ao calendário. Omitir pra criar só com feriados nacionais.

Example:

"GO"

​
cidade
string

Nome da cidade — usado apenas pra log/audit; backend não filtra por cidade no catálogo (filtro municipal usa codigoIbge).

Example:

"Goiânia"

​
codigoIbge
number

Código IBGE de 7 dígitos da capital, pra incluir feriados MUNICIPAIS no calendário. Aceito apenas pras 27 capitais brasileiras (única cobertura do free tier FeriadosAPI). Backend valida silenciosamente — se IBGE não bate com nenhum registro scope=MUNICIPAL no catálogo, calendário criado sem municipais (não erro).

Example:

5208707

Response

Calendário criado e populado com sucesso

​
calendarioId
string
required

Identificador do calendário

Example:

"f8e0a0f5-4f4d-4b4f-9f8d-8f4d4f4d4f4d"

​
descricao
string
required

Nome do calendário

Example:

"Calendário Unidade Goiânia"

​
colaboradores
number
required

Número de colaboradores vinculados

Example:

7