v1

latestOpenAPI 3.0.02026-07-24161168406.5 KB

Employees

Update a employee

When the request for updating employee registration information is sent containing all fields, attention should be paid not to send the 'resignation_date' and 'resignation_reason' fields. These should only be provided in cases of resignation. If they are provided in a case that is not related to resignation, leaving the fields blank will result in an error requesting their completion. The assignment of access profiles (permission_profiles) is not available via API and must be done directly through the platform, on the employee management screen. The access profile (permission_profiles) will only be displayed in the employee query as informational.

put/employees/{id_person}/

Path parameters

id_personinteger required

ID of person

Request body

namestring

Employee's name

social_namestring

Employee's Social Name (max length: 250)

birth_namestring

Employee's birth date (YYYY-MM-DD)

emailstring

Employee's e-mail

cpfstring

Employee's CPF

internal_numberstring

Employee's internal number

cell_phonestring

Employee's cell phone

groupsstring

Name or id_group of groups of employee separated by semicolon

leadersstring

Name, CPF, internal_number of leaders of employee separated by semicolon. CPF can be provided with or without punctuation (e.g., 12345678901 or 123.456.789-01).

languagestring

pt-BR (default) / en-US / es-ES

blockedinteger

Block employee from receiveing notifications

sexstring

Employee's sex (F/M)

genderstring

Employee's gender (max length: 250)

birthdaystring date

Employee's birth date (YYYY-MM-DD)

hiring_datestring date

Employee's hiring date (YYYY-MM-DD)

resignation_datestring date

Employee's resignation date (YYYY-MM-DD)

positionstring

Employee's job role

scholaritystring

Employee's scholarity

unit_businessstring

Employee's business unit

unit_geographystring

Employee's geographic unit

tagsstring[]

Response

Successful response

codeinteger

Can be 1 for success, otherwise 0 for error

messagestring