Pular para o conteúdo
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Desativar Employee

Desativa o employee: nenhuma nova originação para este CPF. Contratos já formalizados não são afetados.

Request

DELETE /api/v1/originator/employees/{publicId}

Autenticação: Authorization: Bearer {originatorToken}.

Parâmetros

Parâmetro
Local
Tipo
Obrigatório
Descrição

publicId

path

string

Sim

Identificador público do employee

Response

204 No Content, sem corpo.

Exemplo

DELETE /api/v1/originator/employees/Kj8mP2xQ9nR4sT6v HTTP/1.1
Host: api.giro.tech
Authorization: Bearer {originatorToken}

Erros

Código

errorCode

Situação

404

—

Employee não encontrado ou de outro originador. Use o publicId (UUID)

429

—

Mais de 75 requisições por segundo

Erros comuns a todos os endpoints — 401, 403 de token, 409 de Idempotency-Key em processamento, 500 e 503 — e o formato ProblemDetail estão em Erros da API.

Desativar Employee

delete
/api/v1/originator/employees/{publicId}

Desativa o trabalhador para impedir novas operações de originação.

Autorizações
AuthorizationstringObrigatório

JWT token fornecido pelo administrador

Parâmetros de rota
publicIdstringObrigatório

Identificador público do employee (16 caracteres)

Respostas
204

Employee desativado com sucesso

Sem conteúdo

delete/api/v1/originator/employees/{publicId}
DELETE /api/v1/originator/employees/{publicId} HTTP/1.1
Host: ingress.gtpayroll.staging.giro.tech
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Sem conteúdo

Atualizado