Skip to main content
POST
/
calendarios
/
{calendarioId}
/
colaboradores
/
transferir
Transfere colaboradores para o calendário informado. Se dataInicio for ausente ou igual a hoje, executa imediatamente. Datas futuras criam agendamento (processado por cron diário).
curl --request POST \
  --url https://api.example.com/calendarios/{calendarioId}/colaboradores/transferir \
  --header 'Content-Type: application/json' \
  --data '
{
  "colaboradorIds": [
    "7b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e"
  ]
}
'
{
  "status": "completed",
  "colaboradoresAfetados": 123,
  "agendamentoId": "<string>",
  "dataExecucao": "2023-11-07T05:31:56Z",
  "executedAt": "2023-11-07T05:31:56Z"
}

Path Parameters

​
calendarioId
string
required

ID do calendario

Body

application/json

Lista de colaboradores e data de início (opcional)

​
colaboradorIds
string[]
required

IDs dos colaboradores a transferir (mínimo 1, máximo 500)

Example:
["7b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e"]
​
dataInicio
string

Data de início da transferência (ISO yyyy-MM-dd). Ausente OU igual a hoje = transferência imediata. Maior que hoje = agendado.

Example:

"2026-05-01"

​
motivo
string

Motivo da transferência (audit log opcional)

Maximum string length: 500

Response

Resultado da transferência (imediata ou agendada)

​
status
enum<string>
required

Status da transferência

Available options:
completed,
scheduled
Example:

"completed"

​
colaboradoresAfetados
number
required

Quantidade de colaboradores afetados

​
agendamentoId
string | null

Identificador do agendamento (presente apenas quando status=scheduled)

​
dataExecucao
string<date-time> | null

Data de execução do agendamento (presente apenas quando status=scheduled)

​
executedAt
string<date-time> | null

Timestamp da execução (presente apenas quando status=completed)