Atualizar colaborador

PUT /api/v1/valepix/employees/{employee_id}

Atualiza dados cadastrais de um colaborador.

Autenticação

Envie um API token ativo no header Authorization.

Authorization: Bearer <VALEPIX_API_TOKEN>
Accept: application/json
Content-Type: application/json

Path params

Parâmetro	Tipo	Obrigatório	Descrição
employee_id	string	Sim	Identificador do colaborador retornado pela API

Body

Todos os campos do body de atualização são opcionais. Envie apenas os campos que deseja alterar.

Campo	Tipo	Descrição
benefit_id	string	Novo benefício do colaborador, obtido pelas rotas de benefícios
name	string	Nome do colaborador
email	string	E-mail do colaborador
phone	string	Telefone brasileiro válido
cbo	string	Código CBO
situation	string	Valor retornado no campo value da rota de situações
admission_date	string	Data de admissão em YYYY-MM-DD
birth_date	string	Data de nascimento em YYYY-MM-DD

Antes de alterar benefit_id, obtenha o novo identificador em Listar benefícios ou Criar benefício. Para criar um benefício, obtenha antes o product_id em Listar produtos. Para alterar situation, use um valor retornado por Situações de colaboradores.

Envie apenas os campos que deseja alterar. O employee_id vem da URL.

Exemplo curl

curl --request PUT \
  --header "Authorization: Bearer $VALEPIX_API_TOKEN" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --url "https://routes.valepix.com.br/api/v1/valepix/employees/$EMPLOYEE_ID" \
  --data '{
    "benefit_id": "<benefit_id_retornado_pela_rota_de_beneficios>",
    "name": "Maria Exemplo Santos",
    "email": "maria.exemplo.novo@empresa.test",
    "phone": "<telefone_valido>",
    "cbo": "4110-05",
    "situation": "active",
    "admission_date": "2024-02-01",
    "birth_date": "1990-05-20"
  }'

Response

{
  "success": "success",
  "data": {
    "success": true
  }
}

Erros comuns

HTTP	Quando acontece	Ação recomendada
400	Payload inválido, telefone inválido, data incorreta ou benefício inexistente	Corrigir dados enviados
401	Token ausente, inválido, expirado ou revogado	Conferir token
403	Token sem acesso ao recurso solicitado	Confirmar token com a ValePix
404	Colaborador não encontrado	Conferir employee_id
500	Erro interno temporário	Tentar novamente com backoff