Skip to main content
PUT
/
core
/
v3
/
employees
/
{id}
Update an employee
curl --request PUT \
  --url https://api-{region}.sesametime.com/core/v3/employees/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "secondLastName": "<string>",
  "email": "jsmith@example.com",
  "contractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": 123,
  "pin": 123,
  "nid": "<string>",
  "secondaryNid": "<string>",
  "ssn": "<string>",
  "phone": "<string>",
  "dateOfBirth": "2023-12-25",
  "customFields": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "value": "My custom value"
    }
  ],
  "nationality": "ES",
  "nationalities": [
    "ES",
    "FR"
  ],
  "maritalStatus": "<string>",
  "address": "<string>",
  "postalCode": "<string>",
  "emergencyPhone": "<string>",
  "childrenCount": 123,
  "disability": 123,
  "personalEmail": "jsmith@example.com",
  "description": "<string>",
  "city": "<string>",
  "province": "<string>",
  "country": "ES",
  "salaryRange": "<string>",
  "studyLevel": "<string>",
  "professionalCategoryCode": "<string>",
  "professionalCategoryDescription": "<string>",
  "bic": "<string>",
  "accountNumber": "<string>",
  "jobChargeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "jobChargeDescription": "<string>",
  "jobChargeCompetencies": "<string>",
  "workPhone": "<string>",
  "mainRecruiter": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "nfc": "<string>",
  "contributionGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
import requests

url = "https://api-{region}.sesametime.com/core/v3/employees/{id}"

payload = {
    "firstName": "<string>",
    "lastName": "<string>",
    "secondLastName": "<string>",
    "email": "jsmith@example.com",
    "contractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "code": 123,
    "pin": 123,
    "nid": "<string>",
    "secondaryNid": "<string>",
    "ssn": "<string>",
    "phone": "<string>",
    "dateOfBirth": "2023-12-25",
    "customFields": [
        {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "value": "My custom value"
        }
    ],
    "nationality": "ES",
    "nationalities": ["ES", "FR"],
    "maritalStatus": "<string>",
    "address": "<string>",
    "postalCode": "<string>",
    "emergencyPhone": "<string>",
    "childrenCount": 123,
    "disability": 123,
    "personalEmail": "jsmith@example.com",
    "description": "<string>",
    "city": "<string>",
    "province": "<string>",
    "country": "ES",
    "salaryRange": "<string>",
    "studyLevel": "<string>",
    "professionalCategoryCode": "<string>",
    "professionalCategoryDescription": "<string>",
    "bic": "<string>",
    "accountNumber": "<string>",
    "jobChargeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "jobChargeDescription": "<string>",
    "jobChargeCompetencies": "<string>",
    "workPhone": "<string>",
    "mainRecruiter": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "nfc": "<string>",
    "contributionGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: '<string>',
    lastName: '<string>',
    secondLastName: '<string>',
    email: 'jsmith@example.com',
    contractId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    code: 123,
    pin: 123,
    nid: '<string>',
    secondaryNid: '<string>',
    ssn: '<string>',
    phone: '<string>',
    dateOfBirth: '2023-12-25',
    customFields: [{id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', value: 'My custom value'}],
    nationality: 'ES',
    nationalities: ['ES', 'FR'],
    maritalStatus: '<string>',
    address: '<string>',
    postalCode: '<string>',
    emergencyPhone: '<string>',
    childrenCount: 123,
    disability: 123,
    personalEmail: 'jsmith@example.com',
    description: '<string>',
    city: '<string>',
    province: '<string>',
    country: 'ES',
    salaryRange: '<string>',
    studyLevel: '<string>',
    professionalCategoryCode: '<string>',
    professionalCategoryDescription: '<string>',
    bic: '<string>',
    accountNumber: '<string>',
    jobChargeId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    jobChargeDescription: '<string>',
    jobChargeCompetencies: '<string>',
    workPhone: '<string>',
    mainRecruiter: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    nfc: '<string>',
    contributionGroupId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api-{region}.sesametime.com/core/v3/employees/{id}', 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-{region}.sesametime.com/core/v3/employees/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'firstName' => '<string>',
    'lastName' => '<string>',
    'secondLastName' => '<string>',
    'email' => 'jsmith@example.com',
    'contractId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'code' => 123,
    'pin' => 123,
    'nid' => '<string>',
    'secondaryNid' => '<string>',
    'ssn' => '<string>',
    'phone' => '<string>',
    'dateOfBirth' => '2023-12-25',
    'customFields' => [
        [
                'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'value' => 'My custom value'
        ]
    ],
    'nationality' => 'ES',
    'nationalities' => [
        'ES',
        'FR'
    ],
    'maritalStatus' => '<string>',
    'address' => '<string>',
    'postalCode' => '<string>',
    'emergencyPhone' => '<string>',
    'childrenCount' => 123,
    'disability' => 123,
    'personalEmail' => 'jsmith@example.com',
    'description' => '<string>',
    'city' => '<string>',
    'province' => '<string>',
    'country' => 'ES',
    'salaryRange' => '<string>',
    'studyLevel' => '<string>',
    'professionalCategoryCode' => '<string>',
    'professionalCategoryDescription' => '<string>',
    'bic' => '<string>',
    'accountNumber' => '<string>',
    'jobChargeId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'jobChargeDescription' => '<string>',
    'jobChargeCompetencies' => '<string>',
    'workPhone' => '<string>',
    'mainRecruiter' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'nfc' => '<string>',
    'contributionGroupId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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-{region}.sesametime.com/core/v3/employees/{id}"

	payload := strings.NewReader("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"secondLastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"contractId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"code\": 123,\n  \"pin\": 123,\n  \"nid\": \"<string>\",\n  \"secondaryNid\": \"<string>\",\n  \"ssn\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"dateOfBirth\": \"2023-12-25\",\n  \"customFields\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"value\": \"My custom value\"\n    }\n  ],\n  \"nationality\": \"ES\",\n  \"nationalities\": [\n    \"ES\",\n    \"FR\"\n  ],\n  \"maritalStatus\": \"<string>\",\n  \"address\": \"<string>\",\n  \"postalCode\": \"<string>\",\n  \"emergencyPhone\": \"<string>\",\n  \"childrenCount\": 123,\n  \"disability\": 123,\n  \"personalEmail\": \"jsmith@example.com\",\n  \"description\": \"<string>\",\n  \"city\": \"<string>\",\n  \"province\": \"<string>\",\n  \"country\": \"ES\",\n  \"salaryRange\": \"<string>\",\n  \"studyLevel\": \"<string>\",\n  \"professionalCategoryCode\": \"<string>\",\n  \"professionalCategoryDescription\": \"<string>\",\n  \"bic\": \"<string>\",\n  \"accountNumber\": \"<string>\",\n  \"jobChargeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"jobChargeDescription\": \"<string>\",\n  \"jobChargeCompetencies\": \"<string>\",\n  \"workPhone\": \"<string>\",\n  \"mainRecruiter\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"nfc\": \"<string>\",\n  \"contributionGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api-{region}.sesametime.com/core/v3/employees/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"secondLastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"contractId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"code\": 123,\n  \"pin\": 123,\n  \"nid\": \"<string>\",\n  \"secondaryNid\": \"<string>\",\n  \"ssn\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"dateOfBirth\": \"2023-12-25\",\n  \"customFields\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"value\": \"My custom value\"\n    }\n  ],\n  \"nationality\": \"ES\",\n  \"nationalities\": [\n    \"ES\",\n    \"FR\"\n  ],\n  \"maritalStatus\": \"<string>\",\n  \"address\": \"<string>\",\n  \"postalCode\": \"<string>\",\n  \"emergencyPhone\": \"<string>\",\n  \"childrenCount\": 123,\n  \"disability\": 123,\n  \"personalEmail\": \"jsmith@example.com\",\n  \"description\": \"<string>\",\n  \"city\": \"<string>\",\n  \"province\": \"<string>\",\n  \"country\": \"ES\",\n  \"salaryRange\": \"<string>\",\n  \"studyLevel\": \"<string>\",\n  \"professionalCategoryCode\": \"<string>\",\n  \"professionalCategoryDescription\": \"<string>\",\n  \"bic\": \"<string>\",\n  \"accountNumber\": \"<string>\",\n  \"jobChargeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"jobChargeDescription\": \"<string>\",\n  \"jobChargeCompetencies\": \"<string>\",\n  \"workPhone\": \"<string>\",\n  \"mainRecruiter\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"nfc\": \"<string>\",\n  \"contributionGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api-{region}.sesametime.com/core/v3/employees/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"secondLastName\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"contractId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"code\": 123,\n  \"pin\": 123,\n  \"nid\": \"<string>\",\n  \"secondaryNid\": \"<string>\",\n  \"ssn\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"dateOfBirth\": \"2023-12-25\",\n  \"customFields\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"value\": \"My custom value\"\n    }\n  ],\n  \"nationality\": \"ES\",\n  \"nationalities\": [\n    \"ES\",\n    \"FR\"\n  ],\n  \"maritalStatus\": \"<string>\",\n  \"address\": \"<string>\",\n  \"postalCode\": \"<string>\",\n  \"emergencyPhone\": \"<string>\",\n  \"childrenCount\": 123,\n  \"disability\": 123,\n  \"personalEmail\": \"jsmith@example.com\",\n  \"description\": \"<string>\",\n  \"city\": \"<string>\",\n  \"province\": \"<string>\",\n  \"country\": \"ES\",\n  \"salaryRange\": \"<string>\",\n  \"studyLevel\": \"<string>\",\n  \"professionalCategoryCode\": \"<string>\",\n  \"professionalCategoryDescription\": \"<string>\",\n  \"bic\": \"<string>\",\n  \"accountNumber\": \"<string>\",\n  \"jobChargeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"jobChargeDescription\": \"<string>\",\n  \"jobChargeCompetencies\": \"<string>\",\n  \"workPhone\": \"<string>\",\n  \"mainRecruiter\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"nfc\": \"<string>\",\n  \"contributionGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "firstName": "Lucas",
    "lastName": "García",
    "secondLastName": "<string>",
    "email": "jsmith@example.com",
    "imageProfileURL": "https://sesame-v2-prod-companies.s3.eu-west-3.amazonaws.com/48351485-1659-413d-bf7f-3ca34fadb521/public-read/g892f1fb-55a3-4e32-9cc9-7c19faa70gaa.png",
    "code": 1,
    "pin": 1000,
    "phone": "+34 111 11 11 11",
    "company": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "notificationEmail": "jsmith@example.com",
      "language": "<string>",
      "createdAt": "2020-01-01T10:00:00+01:00",
      "updatedAt": "2020-01-01T10:00:00+01:00"
    },
    "contractId": "<string>",
    "nid": "<string>",
    "secondaryNid": "<string>",
    "ssn": "<string>",
    "pricePerHour": 123,
    "accountNumber": "<string>",
    "dateOfBirth": "2023-12-25",
    "customFields": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "slug": "<string>",
        "type": "<string>",
        "value": "<string>",
        "createdAt": "2020-01-01T10:00:00+01:00",
        "updatedAt": "2020-01-01T10:00:00+01:00"
      }
    ],
    "createdAt": "2020-01-01T10:00:00+01:00",
    "updatedAt": "2020-01-01T10:00:00+01:00",
    "children": 2,
    "disability": 25,
    "address": "<string>",
    "postalCode": "<string>",
    "city": "<string>",
    "province": "<string>",
    "country": "ES",
    "nationality": "ES",
    "nationalities": [
      "ES",
      "FR"
    ],
    "personalMail": "jsmith@example.com",
    "maritalStatus": "<string>",
    "emergencyPhone": "<string>",
    "description": "<string>",
    "salaryRange": "<string>",
    "studyLevel": "<string>",
    "professionalCategoryCode": "<string>",
    "professionalCategoryDescription": "<string>",
    "bic": "<string>",
    "jobChargeId": "<string>",
    "jobChargeName": "<string>",
    "jobChargeDescription": "<string>",
    "jobChargeCompetencies": "<string>",
    "language": "es-ES",
    "workPhone": "+34 111 11 11 11",
    "mainRecruiter": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "firstName": "Lucas",
      "lastName": "García",
      "secondLastName": "<string>",
      "imageProfileURL": "https://sesame-v2-prod-companies.s3.eu-west-3.amazonaws.com/48351485-1659-413d-bf7f-3ca34fadb521/public-read/g892f1fb-55a3-4e32-9cc9-7c19faa70gaa.png",
      "email": "jsmith@example.com",
      "workCheckTypeColor": "#FF0000",
      "workCheckTypeName": "Remote"
    },
    "nfc": "<string>",
    "contributionGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "meta": {
    "currentPage": 1,
    "lastPage": 1,
    "total": 1,
    "perPage": 1
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

Employee ID

Body

application/json

Employee object that needs to be updated

​
firstName
string
required

The first name of the employee

​
lastName
string
required

The last name of the employee

​
status
enum<string>
required
Available options:
active,
inactive
​
secondLastName
string | null

The employee's second last name field is only available in Mexico and Colombia

Required string length: 1 - 255
​
gender
enum<string>

Allowed values depend on the employee's company:

ScenarioAllowed values
MX with ADP or Nomitek integrationfemale, male
All other companiesfemale, male, no_response, non_binary_gender
Available options:
female,
male,
no_response,
non_binary_gender
​
email
string<email>

The email for the employee access and notifications (required if invitation is true)

​
contractId
string<uuid>

The identifier of your internal employee contract

​
code
integer

The code of the employee

​
pin
integer

The pin of the employee

​
nid
string

The National Identity Document of the employee

​
identityNumberType
enum<string>

Primary identity number type

Available options:
dni,
nie,
rut,
other
​
secondaryIdentityNumberType
enum<string>

Secondary identity number type (must be different from identityNumberType)

Available options:
dni,
nie,
rut,
other
​
secondaryNid
string

The Secondary National Identity Document of the employee

​
ssn
string

The Social Security Number of the employee

​
phone
string
​
dateOfBirth
string<date>
​
customFields
object[]

Custom Fields to fill

​
nationality
string
deprecated

Employee nationality (deprecated, use nationalities instead)

Example:

"ES"

​
nationalities
string[]

Array of employee nationalities

Example:
["ES", "FR"]
​
maritalStatus
string
​
address
string
​
postalCode
string
​
emergencyPhone
string
​
childrenCount
integer
​
disability
integer
​
personalEmail
string<email>
​
description
string
​
city
string
​
province
string
​
country
string | null

Two-letter country code (ISO alpha-2), e.g. 'ES' for Spain, 'MX' for Mexico.

Required string length: 2
Example:

"ES"

​
salaryRange
string
​
studyLevel
string
​
professionalCategoryCode
string
deprecated

Use contributionGroupId instead

​
professionalCategoryDescription
string
​
bic
string
​
accountNumber
string
​
jobChargeId
string<uuid>
​
jobChargeDescription
string

The description of the job position duties and responsibilities

​
jobChargeCompetencies
string

The competencies and skills required for the job position

​
workPhone
string
​
mainRecruiter
string<uuid>
​
nfc
string
​
contributionGroupId
string<uuid>

Use the /contract/v1/contribution-groups endpoint to retrieve the list of contribution groups to be used.

Response

200 - application/json

Object

​
data
object
​
meta
object