01. VISÃO GERAL
Este documento apresenta os parâmetros de entrada e o retorno da API de POST de candidatura.
IMPORTANTE
- A implementação das integrações via API deve ser realizada pelo cliente, que será responsável pelos custos e pelo desenvolvimento envolvidos.
02. ENDPOINT E PARÂMETROS DE ENTRADA
Endpoint da API que será utilizado para inserir e atualizar dados:
| URL base | Endpoint |
|---|---|
| https://api-centraldorecrutador.totvs.app/recruitment-integration | {URL base}/api/v1/job-application/change-status |
2.1 - DADOS ENVIADOS
Segue abaixo um exemplo de corpo que deve ser enviado na API:
{
"jobApplicationStatusChangeCommand": [
{
"jobApplicationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"changeDate": "2025-02-13T11:10:08.318Z",
"newStatus": "Hired"
}
]
}
Atenção
Cada chamada de API não pode ser feita com mais de 100 candidaturas por vez.
Caso sejam enviados mais de 100 candidatos na lista, ocorrerá um erro avisando sobre o limite, e nenhum candidato será atualizado no sistema.
Descrição detalhada do objeto dentro do jobApplicationStatusChangeCommand:
Parâmetro | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| jobApplicationId | ID único que representa a candidatura | texto (string) |
|
| changeDate | Data da alteração no formato 2022-12-20T14:05:20.123-03:00 | texto (string) |  |
| newStatus | Novo status desejado para a candidatura | enum com as seguintes opções:
|
|
Retorno:
Descrição | |
|---|---|
| Valor string | O retorno é uma string que é o identificador do processo que será utilizado no endpoint de consulta para checar o status do processamento do lote |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas