Employees

Update employee

put/employees/{employeeId}

Path parameters

employeeIdinteger required

Request body

nationality'US' | 'UK' | 'FR' | 'DE' | 'NL' | 'PL' | 'IT' | 'ES' | 'IN' required

Nationality of employee as an ISO 3166-1 alpha-2 country code

departmentIdnumber required

keycardIdstring required

accountstring required

officeCodestring required

firstNamestring required

lastNamestring required

positionstring required

emailstring email required

Email address string

skillsSkill[] required

biostring required

imgURLstring

Example request

{
  "nationality": "US",
  "employment": {
    "contractType": "PERMANENT"
  },
  "skills": [
    "JavaScript"
  ]
}

Response

Employee updated successfully

idinteger required

nationality'US' | 'UK' | 'FR' | 'DE' | 'NL' | 'PL' | 'IT' | 'ES' | 'IN' required

Nationality of employee as an ISO 3166-1 alpha-2 country code

departmentstring required

Department display name

departmentIdinteger

Department ID for linking to getDepartmentById (enables EmployeeDepartmentLink)

keycardIdstring required

officestring required

officeCodestring required

namestring required

positionstring required

accountstring required

emailstring email required

Email address string

skillsSkill[] required

biostring required

imgURLstring

Example response

{
  "id": 1234,
  "nationality": "DE",
  "department": "Marketing",
  "departmentId": 1,
  "officeCode": "de-berlin",
  "keycardId": "KC-9876",
  "account": "DE89 3704 0044 0532 0130 00",
  "name": "Hans Schmidt",
  "position": "Senior Developer",
  "email": "hans.schmidt@itcorpo.com",
  "skills": [
    "JavaScript",
    "TypeScript",
    "React"
  ],
  "bio": "Experienced developer with focus on frontend technologies",
  "imgURL": "hans-schmidt-profile.jpg",
  "employment": {
    "contractType": "PERMANENT",
    "currentSalary": 75000,
    "startDate": "2020-01-15",
    "endDate": "2025-01-14",
    "employedFor": {
      "years": 5,
      "months": 0,
      "days": 0
    }
  },
  "personalInfo": {
    "age": 35,
    "phone": "+49 123 456789",
    "email": "hans.schmidt@gmail.com",
    "dateOfBirth": "1988-05-20T00:00:00.000Z",
    "address": {
      "street": "Alexanderplatz 1",
      "city": "Berlin",
      "country": "Germany"
    }
  }
}

Changes

Changed in 9 of the 28 revisions of this API.351435

Jul 13, 202680675117301b1See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
Sep 10, 2025417afc8900701See the full diff
- ○
  added the required property to the response with the status
  response-required-property-added
Jan 24, 2025512d594a5f711See the full diff
- ○
  added the required property / to the response with the status
  response-required-property-added
Jan 24, 2025542ef1d43cc71373See the full diff
- ▲
  added the new required request property
  new-required-request-property
- ▲
  added the new required request property
  new-required-request-property
- ▲
  added the new required request property
  new-required-request-property
- ▲
  the response property's minItems was decreased from 2 to 0 for the response status
  response-property-min-items-decreased
- ▲
  the response's property type changed from array to string for status
  response-property-type-changed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property /
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
Jan 17, 20254573748c63386See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jan 16, 20253a97c5571c57121See the full diff
- ▲
  added the new required request property
  new-required-request-property
- ●
  removed the request property
  request-property-removed
- ●
  added the new IN enum value to the response property for the response status
  response-property-enum-value-added
- ○
  added the new IN enum value to the request property
  request-property-enum-value-added
Jan 9, 2025a59b7402c51442See the full diff
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 9, 202529074eeb2bb56See the full diff
- ○
  removed the pattern ^[+]?[(]?[0-9]{1,4}[)]?[-\s\./0-9]*$ from the request property /
  request-property-pattern-removed
- ○
  added the media type application/json for the response with the status
  response-media-type-added
- ○
  added the media type application/json for the response with the status
  response-media-type-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  the / response's property pattern ^[+]?[(]?[0-9]{1,4}[)]?[-\s\./0-9]*$ was removed for the status
  response-property-pattern-removed
Jan 7, 2025659ddbe31a5817514See the full diff
- ▲
  added the new required request property
  new-required-request-property
- ▲
  added the new required request property
  new-required-request-property
- ▲
  added the new required request property
  new-required-request-property
- ▲
  added the new required request property
  new-required-request-property
- ▲
  added the new required request property
  new-required-request-property
- ▲
  added the new required request property /
  new-required-request-property
- ▲
  added the new required request property
  new-required-request-property
- ▲
  added the new required request property
  new-required-request-property
- ▲
  removed the enum value IN of the request property
  request-property-enum-value-removed
- ▲
  added the pattern ^[+]?[(]?[0-9]{1,4}[)]?[-\s\./0-9]*$ to the request property /
  request-property-pattern-added
- ▲
  removed the media type application/json for the response with the status
  response-media-type-removed
- ▲
  removed the media type application/json for the response with the status
  response-media-type-removed
- ▲
  the response's property type changed from string to array for status
  response-property-type-changed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the IN enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  the / response's property pattern ^[+]?[(]?[0-9]{1,4}[)]?[-\s\./0-9]*$ was added for the status
  response-property-pattern-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property / to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history