cURL
curl --request POST \
--url https://api.salvy.com.br/api/v1/employees/sync \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"integrationId": "123",
"fullName": "João da Silva",
"status": "active",
"forceCreate": false,
"socialName": "João",
"workEmail": "joaosilva@empresa.com.br",
"personalEmail": "joaos04@gmail.com",
"workPhoneNumber": "+5541923456789",
"personalPhoneNumber": "+5541987654321",
"cpf": "198.099.750-07",
"position": "Desenvolvedor",
"area": "Engenharia",
"managerFullName": "Maria dos Santos",
"birthDate": "1990-04-15",
"admittedAt": "2020-05-27",
"terminatedAt": "2021-01-20",
"address": {
"zipCode": "12345-678",
"streetName": "Rua das Flores",
"streetNumber": "123",
"complement": "Apto 101",
"neighborhood": "Jardim das Flores",
"city": "São Paulo",
"state": "SP",
"country": "Brasil"
}
}
'import requests
url = "https://api.salvy.com.br/api/v1/employees/sync"
payload = {
"integrationId": "123",
"fullName": "João da Silva",
"status": "active",
"forceCreate": False,
"socialName": "João",
"workEmail": "joaosilva@empresa.com.br",
"personalEmail": "joaos04@gmail.com",
"workPhoneNumber": "+5541923456789",
"personalPhoneNumber": "+5541987654321",
"cpf": "198.099.750-07",
"position": "Desenvolvedor",
"area": "Engenharia",
"managerFullName": "Maria dos Santos",
"birthDate": "1990-04-15",
"admittedAt": "2020-05-27",
"terminatedAt": "2021-01-20",
"address": {
"zipCode": "12345-678",
"streetName": "Rua das Flores",
"streetNumber": "123",
"complement": "Apto 101",
"neighborhood": "Jardim das Flores",
"city": "São Paulo",
"state": "SP",
"country": "Brasil"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
integrationId: '123',
fullName: 'João da Silva',
status: 'active',
forceCreate: false,
socialName: 'João',
workEmail: 'joaosilva@empresa.com.br',
personalEmail: 'joaos04@gmail.com',
workPhoneNumber: '+5541923456789',
personalPhoneNumber: '+5541987654321',
cpf: '198.099.750-07',
position: 'Desenvolvedor',
area: 'Engenharia',
managerFullName: 'Maria dos Santos',
birthDate: '1990-04-15',
admittedAt: '2020-05-27',
terminatedAt: '2021-01-20',
address: {
zipCode: '12345-678',
streetName: 'Rua das Flores',
streetNumber: '123',
complement: 'Apto 101',
neighborhood: 'Jardim das Flores',
city: 'São Paulo',
state: 'SP',
country: 'Brasil'
}
})
};
fetch('https://api.salvy.com.br/api/v1/employees/sync', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.salvy.com.br/api/v1/employees/sync",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'integrationId' => '123',
'fullName' => 'João da Silva',
'status' => 'active',
'forceCreate' => false,
'socialName' => 'João',
'workEmail' => 'joaosilva@empresa.com.br',
'personalEmail' => 'joaos04@gmail.com',
'workPhoneNumber' => '+5541923456789',
'personalPhoneNumber' => '+5541987654321',
'cpf' => '198.099.750-07',
'position' => 'Desenvolvedor',
'area' => 'Engenharia',
'managerFullName' => 'Maria dos Santos',
'birthDate' => '1990-04-15',
'admittedAt' => '2020-05-27',
'terminatedAt' => '2021-01-20',
'address' => [
'zipCode' => '12345-678',
'streetName' => 'Rua das Flores',
'streetNumber' => '123',
'complement' => 'Apto 101',
'neighborhood' => 'Jardim das Flores',
'city' => 'São Paulo',
'state' => 'SP',
'country' => 'Brasil'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.salvy.com.br/api/v1/employees/sync"
payload := strings.NewReader("{\n \"integrationId\": \"123\",\n \"fullName\": \"João da Silva\",\n \"status\": \"active\",\n \"forceCreate\": false,\n \"socialName\": \"João\",\n \"workEmail\": \"joaosilva@empresa.com.br\",\n \"personalEmail\": \"joaos04@gmail.com\",\n \"workPhoneNumber\": \"+5541923456789\",\n \"personalPhoneNumber\": \"+5541987654321\",\n \"cpf\": \"198.099.750-07\",\n \"position\": \"Desenvolvedor\",\n \"area\": \"Engenharia\",\n \"managerFullName\": \"Maria dos Santos\",\n \"birthDate\": \"1990-04-15\",\n \"admittedAt\": \"2020-05-27\",\n \"terminatedAt\": \"2021-01-20\",\n \"address\": {\n \"zipCode\": \"12345-678\",\n \"streetName\": \"Rua das Flores\",\n \"streetNumber\": \"123\",\n \"complement\": \"Apto 101\",\n \"neighborhood\": \"Jardim das Flores\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"country\": \"Brasil\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.salvy.com.br/api/v1/employees/sync")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"integrationId\": \"123\",\n \"fullName\": \"João da Silva\",\n \"status\": \"active\",\n \"forceCreate\": false,\n \"socialName\": \"João\",\n \"workEmail\": \"joaosilva@empresa.com.br\",\n \"personalEmail\": \"joaos04@gmail.com\",\n \"workPhoneNumber\": \"+5541923456789\",\n \"personalPhoneNumber\": \"+5541987654321\",\n \"cpf\": \"198.099.750-07\",\n \"position\": \"Desenvolvedor\",\n \"area\": \"Engenharia\",\n \"managerFullName\": \"Maria dos Santos\",\n \"birthDate\": \"1990-04-15\",\n \"admittedAt\": \"2020-05-27\",\n \"terminatedAt\": \"2021-01-20\",\n \"address\": {\n \"zipCode\": \"12345-678\",\n \"streetName\": \"Rua das Flores\",\n \"streetNumber\": \"123\",\n \"complement\": \"Apto 101\",\n \"neighborhood\": \"Jardim das Flores\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"country\": \"Brasil\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.salvy.com.br/api/v1/employees/sync")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"integrationId\": \"123\",\n \"fullName\": \"João da Silva\",\n \"status\": \"active\",\n \"forceCreate\": false,\n \"socialName\": \"João\",\n \"workEmail\": \"joaosilva@empresa.com.br\",\n \"personalEmail\": \"joaos04@gmail.com\",\n \"workPhoneNumber\": \"+5541923456789\",\n \"personalPhoneNumber\": \"+5541987654321\",\n \"cpf\": \"198.099.750-07\",\n \"position\": \"Desenvolvedor\",\n \"area\": \"Engenharia\",\n \"managerFullName\": \"Maria dos Santos\",\n \"birthDate\": \"1990-04-15\",\n \"admittedAt\": \"2020-05-27\",\n \"terminatedAt\": \"2021-01-20\",\n \"address\": {\n \"zipCode\": \"12345-678\",\n \"streetName\": \"Rua das Flores\",\n \"streetNumber\": \"123\",\n \"complement\": \"Apto 101\",\n \"neighborhood\": \"Jardim das Flores\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"country\": \"Brasil\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "123e4567-e89b-12d3-a456-426614174000",
"fullName": "João da Silva",
"socialName": "João",
"status": "active",
"workEmail": "joaosilva@empresa.com.br",
"personalEmail": "joaos04@gmail.com",
"workPhoneNumber": "+5541923456789",
"personalPhoneNumber": "+5541987654321",
"cpf": "198.099.750-07",
"cnpj": "82.530.339/0001-64",
"rg": "12.345.678-9",
"position": "Desenvolvedor",
"area": "Engenharia",
"managerFullName": "Maria dos Santos",
"birthDate": "1990-04-15",
"contractType": "clt",
"contractEndDate": "2023-12-31",
"admittedAt": "2020-05-27",
"terminatedAt": "2021-01-30",
"address": {
"zipCode": "12345-678",
"streetName": "Rua das Flores",
"streetNumber": "123",
"complement": "Apto 101",
"neighborhood": "Jardim das Flores",
"city": "São Paulo",
"state": "SP",
"country": "Brasil"
},
"customFields": [
{
"label": "teste",
"type": "text",
"value": "teste"
}
],
"bankAccount": {
"bank": "Banco do Brasil",
"branch": "1234",
"accountNumber": "123456",
"accountType": "checking",
"pixKey": "joao04@gmail.com"
},
"salaryCents": 500000,
"sources": [
{
"id": "123",
"platform": "api"
}
],
"createdAt": "2025-01-01T00:00:00.000Z"
}{
"code": "unauthorized",
"message": "<string>",
"publicDetails": {}
}{
"code": "forbidden",
"message": "<string>",
"publicDetails": {}
}{
"code": "resource-not-found",
"message": "<string>",
"publicDetails": {}
}{
"code": "payload-too-large",
"message": "<string>",
"publicDetails": {}
}{
"code": "input-validation-error",
"message": "<string>",
"publicDetails": {}
}{
"code": "too-many-attempts",
"message": "<string>",
"publicDetails": {}
}{
"code": "unknown",
"message": "<string>",
"publicDetails": {}
}Colaboradores
Sincronizar colaboradores
deprecated
[DEPRECADO] Descontinuado em 2026-08-11; deixa de ser atendido em 2027-02-01. Utilize https://api.salvy.com.br/api/v2/employees/sync em substituição. Detalhes e instruções de migração: https://docs.salvy.com.br/api-reference/deprecation
Cria ou atualiza um colaborador.
Escopo necessário: employee:sync
POST
/
api
/
v1
/
employees
/
sync
cURL
curl --request POST \
--url https://api.salvy.com.br/api/v1/employees/sync \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"integrationId": "123",
"fullName": "João da Silva",
"status": "active",
"forceCreate": false,
"socialName": "João",
"workEmail": "joaosilva@empresa.com.br",
"personalEmail": "joaos04@gmail.com",
"workPhoneNumber": "+5541923456789",
"personalPhoneNumber": "+5541987654321",
"cpf": "198.099.750-07",
"position": "Desenvolvedor",
"area": "Engenharia",
"managerFullName": "Maria dos Santos",
"birthDate": "1990-04-15",
"admittedAt": "2020-05-27",
"terminatedAt": "2021-01-20",
"address": {
"zipCode": "12345-678",
"streetName": "Rua das Flores",
"streetNumber": "123",
"complement": "Apto 101",
"neighborhood": "Jardim das Flores",
"city": "São Paulo",
"state": "SP",
"country": "Brasil"
}
}
'import requests
url = "https://api.salvy.com.br/api/v1/employees/sync"
payload = {
"integrationId": "123",
"fullName": "João da Silva",
"status": "active",
"forceCreate": False,
"socialName": "João",
"workEmail": "joaosilva@empresa.com.br",
"personalEmail": "joaos04@gmail.com",
"workPhoneNumber": "+5541923456789",
"personalPhoneNumber": "+5541987654321",
"cpf": "198.099.750-07",
"position": "Desenvolvedor",
"area": "Engenharia",
"managerFullName": "Maria dos Santos",
"birthDate": "1990-04-15",
"admittedAt": "2020-05-27",
"terminatedAt": "2021-01-20",
"address": {
"zipCode": "12345-678",
"streetName": "Rua das Flores",
"streetNumber": "123",
"complement": "Apto 101",
"neighborhood": "Jardim das Flores",
"city": "São Paulo",
"state": "SP",
"country": "Brasil"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
integrationId: '123',
fullName: 'João da Silva',
status: 'active',
forceCreate: false,
socialName: 'João',
workEmail: 'joaosilva@empresa.com.br',
personalEmail: 'joaos04@gmail.com',
workPhoneNumber: '+5541923456789',
personalPhoneNumber: '+5541987654321',
cpf: '198.099.750-07',
position: 'Desenvolvedor',
area: 'Engenharia',
managerFullName: 'Maria dos Santos',
birthDate: '1990-04-15',
admittedAt: '2020-05-27',
terminatedAt: '2021-01-20',
address: {
zipCode: '12345-678',
streetName: 'Rua das Flores',
streetNumber: '123',
complement: 'Apto 101',
neighborhood: 'Jardim das Flores',
city: 'São Paulo',
state: 'SP',
country: 'Brasil'
}
})
};
fetch('https://api.salvy.com.br/api/v1/employees/sync', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.salvy.com.br/api/v1/employees/sync",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'integrationId' => '123',
'fullName' => 'João da Silva',
'status' => 'active',
'forceCreate' => false,
'socialName' => 'João',
'workEmail' => 'joaosilva@empresa.com.br',
'personalEmail' => 'joaos04@gmail.com',
'workPhoneNumber' => '+5541923456789',
'personalPhoneNumber' => '+5541987654321',
'cpf' => '198.099.750-07',
'position' => 'Desenvolvedor',
'area' => 'Engenharia',
'managerFullName' => 'Maria dos Santos',
'birthDate' => '1990-04-15',
'admittedAt' => '2020-05-27',
'terminatedAt' => '2021-01-20',
'address' => [
'zipCode' => '12345-678',
'streetName' => 'Rua das Flores',
'streetNumber' => '123',
'complement' => 'Apto 101',
'neighborhood' => 'Jardim das Flores',
'city' => 'São Paulo',
'state' => 'SP',
'country' => 'Brasil'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.salvy.com.br/api/v1/employees/sync"
payload := strings.NewReader("{\n \"integrationId\": \"123\",\n \"fullName\": \"João da Silva\",\n \"status\": \"active\",\n \"forceCreate\": false,\n \"socialName\": \"João\",\n \"workEmail\": \"joaosilva@empresa.com.br\",\n \"personalEmail\": \"joaos04@gmail.com\",\n \"workPhoneNumber\": \"+5541923456789\",\n \"personalPhoneNumber\": \"+5541987654321\",\n \"cpf\": \"198.099.750-07\",\n \"position\": \"Desenvolvedor\",\n \"area\": \"Engenharia\",\n \"managerFullName\": \"Maria dos Santos\",\n \"birthDate\": \"1990-04-15\",\n \"admittedAt\": \"2020-05-27\",\n \"terminatedAt\": \"2021-01-20\",\n \"address\": {\n \"zipCode\": \"12345-678\",\n \"streetName\": \"Rua das Flores\",\n \"streetNumber\": \"123\",\n \"complement\": \"Apto 101\",\n \"neighborhood\": \"Jardim das Flores\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"country\": \"Brasil\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.salvy.com.br/api/v1/employees/sync")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"integrationId\": \"123\",\n \"fullName\": \"João da Silva\",\n \"status\": \"active\",\n \"forceCreate\": false,\n \"socialName\": \"João\",\n \"workEmail\": \"joaosilva@empresa.com.br\",\n \"personalEmail\": \"joaos04@gmail.com\",\n \"workPhoneNumber\": \"+5541923456789\",\n \"personalPhoneNumber\": \"+5541987654321\",\n \"cpf\": \"198.099.750-07\",\n \"position\": \"Desenvolvedor\",\n \"area\": \"Engenharia\",\n \"managerFullName\": \"Maria dos Santos\",\n \"birthDate\": \"1990-04-15\",\n \"admittedAt\": \"2020-05-27\",\n \"terminatedAt\": \"2021-01-20\",\n \"address\": {\n \"zipCode\": \"12345-678\",\n \"streetName\": \"Rua das Flores\",\n \"streetNumber\": \"123\",\n \"complement\": \"Apto 101\",\n \"neighborhood\": \"Jardim das Flores\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"country\": \"Brasil\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.salvy.com.br/api/v1/employees/sync")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"integrationId\": \"123\",\n \"fullName\": \"João da Silva\",\n \"status\": \"active\",\n \"forceCreate\": false,\n \"socialName\": \"João\",\n \"workEmail\": \"joaosilva@empresa.com.br\",\n \"personalEmail\": \"joaos04@gmail.com\",\n \"workPhoneNumber\": \"+5541923456789\",\n \"personalPhoneNumber\": \"+5541987654321\",\n \"cpf\": \"198.099.750-07\",\n \"position\": \"Desenvolvedor\",\n \"area\": \"Engenharia\",\n \"managerFullName\": \"Maria dos Santos\",\n \"birthDate\": \"1990-04-15\",\n \"admittedAt\": \"2020-05-27\",\n \"terminatedAt\": \"2021-01-20\",\n \"address\": {\n \"zipCode\": \"12345-678\",\n \"streetName\": \"Rua das Flores\",\n \"streetNumber\": \"123\",\n \"complement\": \"Apto 101\",\n \"neighborhood\": \"Jardim das Flores\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"country\": \"Brasil\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "123e4567-e89b-12d3-a456-426614174000",
"fullName": "João da Silva",
"socialName": "João",
"status": "active",
"workEmail": "joaosilva@empresa.com.br",
"personalEmail": "joaos04@gmail.com",
"workPhoneNumber": "+5541923456789",
"personalPhoneNumber": "+5541987654321",
"cpf": "198.099.750-07",
"cnpj": "82.530.339/0001-64",
"rg": "12.345.678-9",
"position": "Desenvolvedor",
"area": "Engenharia",
"managerFullName": "Maria dos Santos",
"birthDate": "1990-04-15",
"contractType": "clt",
"contractEndDate": "2023-12-31",
"admittedAt": "2020-05-27",
"terminatedAt": "2021-01-30",
"address": {
"zipCode": "12345-678",
"streetName": "Rua das Flores",
"streetNumber": "123",
"complement": "Apto 101",
"neighborhood": "Jardim das Flores",
"city": "São Paulo",
"state": "SP",
"country": "Brasil"
},
"customFields": [
{
"label": "teste",
"type": "text",
"value": "teste"
}
],
"bankAccount": {
"bank": "Banco do Brasil",
"branch": "1234",
"accountNumber": "123456",
"accountType": "checking",
"pixKey": "joao04@gmail.com"
},
"salaryCents": 500000,
"sources": [
{
"id": "123",
"platform": "api"
}
],
"createdAt": "2025-01-01T00:00:00.000Z"
}{
"code": "unauthorized",
"message": "<string>",
"publicDetails": {}
}{
"code": "forbidden",
"message": "<string>",
"publicDetails": {}
}{
"code": "resource-not-found",
"message": "<string>",
"publicDetails": {}
}{
"code": "payload-too-large",
"message": "<string>",
"publicDetails": {}
}{
"code": "input-validation-error",
"message": "<string>",
"publicDetails": {}
}{
"code": "too-many-attempts",
"message": "<string>",
"publicDetails": {}
}{
"code": "unknown",
"message": "<string>",
"publicDetails": {}
}Este endpoint recebe um snapshot dos dados do colaborador e cria ou atualiza o colaborador na plataforma Salvy.
Snapshot via API:
Resultado:
- O snapshot enviado fica armazenado de forma separada das outras fontes de informação (como edições manuais) e novos envios sobreescrevem o snapshot anterior desse colaborador.
- A Salvy faz a conciliação entre as integrações ativas (priorizando a mais recente) e as edições manuais (prioridade máxima) para determinar quais dados exibir ao usuário final.
Junção automática com colaboradores existentes
Ao utilizar o endpoint desync pela primeira vez para um colaborador, tentamos juntá-lo a um colaborador já existente na plataforma. Por exemplo, um colaborador criado manualmente ou via planilha.
Buscamos colaboradores já existentes por uma ordem de prioridade, nesta sequência:
integrationIdigualcpfigual (se fornecido)workEmailigual (se fornecido)fullNameigual, e: a. SeworkEmailfor fornecido, e o colaborador existente não possuirworkEmail(para permitir cadastro deworkEmailpor este endpoint) b. SeworkEmailnão for fornecido- Caso não seja encontrado, criamos um novo colaborador
integrationId para garantir que o colaborador correto seja atualizado.
Exemplo de conciliação de fontes
Edição manual:{
"fullName": "João da Silva",
"workEmail": "joaosilva@empresa.com.br",
"status": "active"
}
{
"fullName": "João da Silva Santos",
"workEmail": "joaosilva@empresa.com.br",
"personalEmail": "joao04@gmail.com",
"status": "active"
}
{
"fullName": "João da Silva",
"workEmail": "joaosilva@empresa.com.br",
"personalEmail": "joao04@gmail.com",
"status": "active"
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Identificador único de sua escolha para esse colaborador
Example:
"123"
Nome completo
Minimum string length:
1Example:
"João da Silva"
Situação do colaborador
Available options:
active, terminated, on-hold Example:
"active"
Quando true, ignora a busca por colaboradores existentes (por integrationId, cpf, workEmail e fullName) e cria um novo colaborador. Útil para cadastrar intencionalmente um colaborador duplicado.
Example:
false
Nome social
Example:
"João"
E-mail profissional
Example:
"joaosilva@empresa.com.br"
E-mail pessoal
Example:
"joaos04@gmail.com"
Telefone profissional
Example:
"+5541923456789"
Telefone pessoal
Example:
"+5541987654321"
Número do CPF
Example:
"198.099.750-07"
Cargo do colaborador
Example:
"Desenvolvedor"
Área do colaborador
Example:
"Engenharia"
Nome do gestor
Example:
"Maria dos Santos"
Data de nascimento
Example:
"1990-04-15"
Data de admissão
Example:
"2020-05-27"
Data de desligamento
Example:
"2021-01-20"
Endereço do colaborador
Show child attributes
Show child attributes
Response
Identificador do colaborador na plataforma Salvy (UUID)
Examples:
"123e4567-e89b-12d3-a456-426614174000"
"123e4567-e89b-12d3-a456-426614174001"
Nome completo
Example:
"João da Silva"
Nome social
Example:
"João"
Situação do colaborador
Available options:
active, terminated, on-hold Example:
"active"
E-mail profissional
Example:
"joaosilva@empresa.com.br"
E-mail pessoal
Example:
"joaos04@gmail.com"
Telefone profissional
Example:
"+5541923456789"
Telefone pessoal
Example:
"+5541987654321"
Número do CPF
Example:
"198.099.750-07"
CNPJ do colaborador
Example:
"82.530.339/0001-64"
RG do colaborador
Example:
"12.345.678-9"
Cargo do colaborador
Example:
"Desenvolvedor"
Área do colaborador
Example:
"Engenharia"
Nome do gestor
Example:
"Maria dos Santos"
Data de nascimento
Example:
"1990-04-15"
Tipo de contrato
Available options:
pj, clt, intern, apprentice, temporary, third-party Example:
"clt"
Data de término do contrato
Example:
"2023-12-31"
Data de admissão
Example:
"2020-05-27"
Data de desligamento
Example:
"2021-01-30"
Endereço do colaborador
Show child attributes
Show child attributes
Campos personalizados do colaborador
Show child attributes
Show child attributes
Example:
[
{
"label": "teste",
"type": "text",
"value": "teste"
}
]
Dados bancários do colaborador
Show child attributes
Show child attributes
Salário em centavos
Example:
500000
Fontes de integração do colaborador
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Example:
[{ "id": "123", "platform": "api" }]
Data de criação do colaborador
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Example:
"2025-01-01T00:00:00.000Z"