Skip to main content
PATCH
Partially update an employee
Version:v4

Authorizations

Authorization
string
header
required

Sesame Public API consumer token (Authorization: Bearer )

Path Parameters

employeeId
string<uuid>
required

Body

application/json

Send only the fields you want to change. A field that is not sent is left untouched. An explicit null clears the value only for email (the notification email) and for the value of a custom field; null in any other field is rejected with a 422 and nothing is saved. Accepts the same fields, with the same validation rules, as the v3 PUT. code and pin must be sent together. The body cannot be empty.

accountNumber
string
address
string
bic
string
childrenCount
integer
city
string
code
integer

Must be sent together with pin.

contractId
string
contributionGroupId
string<uuid>
country
string

Two-letter country code (ISO alpha-2), e.g. ES, the same format the GET returns.

Required string length: 2
Example:

"ES"

customFields
object[]

Pairs to create or update. A value of null deletes that custom field value; custom fields that are not listed are left untouched.

dateOfBirth
string<date>
description
string
disability
integer
email
string<email> | null

Notification email. null clears it.

emergencyPhone
string
firstName
string
gender
string
identityNumberType
string
jobChargeCompetencies
string
jobChargeDescription
string
lastName
string
mainRecruiter
string<uuid>
maritalStatus
string
nationalities
string[]

Replaces the whole list of nationalities. An empty list [] removes them all. Takes precedence over nationality when both are sent.

nationality
string

Single nationality. Ignored when nationalities is also sent.

nfc
string
nid
string
personalEmail
string<email>
phone
string
pin
integer

Must be sent together with code.

postalCode
string
pricePerHour
number<float>
Required range: x >= 0
professionalCategoryCode
string
professionalCategoryDescription
string
province
string
remote
boolean
salaryRange
string
secondLastName
string
secondaryIdentityNumberType
string
secondaryNid
string
ssn
string
status
string
studyLevel
string
workPhone
string

Response

The employee was updated.