Desligar colaborador
Utilize esse método para desligar colaboradores na plataforma de forma imediata. Caso deseje desligar os colaboradores de forma programa, consulte a seção abaixo. Essa ação só é reversível pela plataforma.
Método
DELETE
api/v2/users/:key
Headers
| Header | Valor |
|---|---|
| Authorization | Bearer access_token |
Obtenha o access_token pelo método de autenticação.
Atributos
Obrigatórios
| Atributos | Tipo | Descrição |
|---|---|---|
| key | string | Chave do colaborador usada no cadastro (email ou matrícula) |
Resposta
200
{
"message": "Colaborador Diego Oliveira dos Santos desligado(a)"
}
401
{
"error": "access token expired"
}
Nesse caso, verifique se o access_token no header Authorization está correto.
404
{
"error": "user not found"
}
Nesse caso, não existe colaborador para a chave informada.
Programar desligamento
Utilize esse método para desligar colaboradores na plataforma de forma programada.
Método
PATCH
api/v2/users/:key/terminate
Headers
| Header | Valor |
|---|---|
| Authorization | Bearer access_token |
Obtenha o access_token pelo método de autenticação.
Atributos
Obrigatórios
| Atributos | Tipo | Descrição |
|---|---|---|
| key | string | Chave do colaborador usada no cadastro (email ou matrícula) |
| schedule_date | date | Data de desligamento no formato DD/MM/YYYY |
| external_reference | string | Referência externa ao seu sistema |
Requisição
{
"schedule_date": "25/11/2025",
"external_reference": "REQ-001"
}
Atenção
Caso a data de desligamento não seja informada, a plataforma desligará imediamente o colaborador.