Skip to main content
PATCH
Public Update Employee
Atualiza dados de um funcionário existente.
Este endpoint funciona como um PATCH real.
  • Envie apenas os campos que deseja atualizar.
  • Não é necessário reenviar todos os campos do funcionário.
  • Campos omitidos não serão alterados.

Visão Geral

Campos

  • Método: PATCH
  • Path: /v0/employee/{employee_id}
  • OperationId: public_update_employee_v0_employee__employee_id__patch
  • Autenticação: header x-api-key

Exemplos de requisição

1) Atualização parcial mínima (somente um campo)

Neste exemplo, apenas o campo employee_name será alterado; os demais campos do funcionário permanecem inalterados.

2) Atualização de múltiplos campos (omitindo os demais)

Somente os campos presentes no corpo (employee_name, is_active, client_integration_code) serão atualizados; todos os outros permanecem como estão.

Authorizations

x-api-key
string
header
required

Path Parameters

employee_id
string<uuid>
required

Body

application/json
address
string | null
address_number
string | null
address_detail
string | null
zip_code
string | null
neighborhood
string | null
state
string | null
city
string | null
name
string | null
social_name
string | null
gov_id
string | null
birth_date
string<date> | null
is_disabled
boolean | null
status
enum<string> | null
Available options:
Ativo,
Inativo,
Afastado,
Férias,
Pendente
sex
enum<string> | null
Available options:
M,
F
gender
enum<string> | null
Available options:
Cis,
Trans
mother_name
string | null
marital_status
enum<string> | null
Available options:
Não informado,
Solteiro,
Casado,
Separado,
Desquitado,
Viúvo,
Outros,
Divorciado,
União Estável
place_of_birth
string | null
educational_stage
enum<string> | null
Available options:
Indefinida,
Ensino Fundamental Incompleto,
Ensino Fundamental Completo,
Ensino Medio Incompleto,
Ensino Medio Completo,
Ensino Superior Incompleto,
Ensino Superior Completo,
Profissionalizante,
Técnico Incompleto,
Técnico Completo,
Tecnólogo Incompleto,
Tecnólogo Completo,
Pós-graduação Incompleta,
Pós-graduação Completo,
Mestrado Incompleto,
Mestrado Completo,
Doutorado Incompleto,
Doutorado Completo,
PHD Incompleto,
PHD Completo,
Não Informado,
Analfabeto
human_skin_tone
enum<string> | null
Available options:
Indefinido,
Branca,
Preta,
Parda,
Amarela,
Indígena,
Mulato
phone
string | null
cell_phone
string | null
email
string | null
personal_email
string | null
admission_date
string<date> | null
hr_code
string | null
employee_registration_number
string | null
work_shift
string | null
organization_id
string<uuid> | null
branch_id
string<uuid> | null
position_id
string<uuid> | null
sector_id
string<uuid> | null
client_integration_code
string | null
dismissal_date
string<date> | null

Response

Successful Response

id
string<uuid>
required
name
string
required
is_disabled
boolean
required
status
string
required
sex
string
required
admission_date
string<date>
required
is_active
boolean
required
organization
SimpleEntity · object
required
branch
SimpleEntity · object
required
position
SimpleEntity · object
required
sector
SimpleEntity · object
required
social_name
string | null
gov_id
string | null
birth_date
string<date> | null
gender
string | null
mother_name
string | null
marital_status
string | null
place_of_birth
string | null
educational_stage
string | null
human_skin_tone
string | null
phone
string | null
cell_phone
string | null
email
string | null
personal_email
string | null
dismissal_date
string<date> | null
hr_code
string | null
employee_registration_number
string | null
work_shift
string | null
client_integration_code
string | null
address
Address · object | null