Create a employee

post

https://www.pulses.com.br/api/engage/v1/employees/

The fields cpf, internal_number, and email are identifiers of the employee, with at least one of them being mandatory to fill in, and all three fields can contain information. 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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Employee object

name

string

length ≤ 250

Employee's name

social_name

string

length ≤ 250

Employee's Social Name (max length: 250)

birth_name

string

length ≤ 250

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

string

length ≤ 250

Employee's e-mail

cpf

string

length ≤ 15

Employee's CPF

internal_number

string

length ≤ 50

Employee's internal number

cell_phone

string

length ≤ 255

Employee's cell phone

groups

string

Name or id_group of groups of employee separated by semicolon

leaders

string

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).

language

string

length ≤ 5

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

blocked

integer

Block employee from receiveing notifications

sex

string

length ≤ 1

Employee's sex (F/M)

gender

string

length ≤ 1

Employee's gender (max length: 250)

birthday

date

length ≤ 10

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

hiring_date

date

length ≤ 10

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

resignation_date

date

length ≤ 10

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

position

string

length ≤ 255

Employee's job role

scholarity

string

length ≤ 255

Employee's scholarity

unit_business

string

length ≤ 255

Employee's business unit

unit_geography

string

length ≤ 255

Employee's geographic unit

200Successful response