Update Person

PATCH /people/{id}

Group: People Management › People · Operation ID: updatePerson

Updates the person with the given identifier. Only the fields in the request body change. Use the person's id, not their employeeNumber.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "v1" yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.
id path string yes The unique identifier for the person to update.

Request body

Required, application/json: updatePersonInput.

Field Type Required Description
firstName string no The person's first name. Changing first or last name recomputes the display name.
lastName string no The person's last name. Changing first or last name recomputes the display name.
middleName string no The person's middle name.
email string no The person's work email address. It is stored in lowercase.
personalEmail string no The person's personal email address. It is stored in lowercase.
gender string no The person's self-identified gender. Any string value is accepted.
dateOfBirth string no The person's date of birth. Use format YYYY-MM-DD.
nationality string no The person's nationality. Format ISO 3166-1 alpha-2, for example 'US'.
startDate string no The employment start date. Use format YYYY-MM-DD. It must not overlap the person's other employee profiles. Changing it also re-anchors incomplete boarding deadlines and, for future-dated employments, absence policy assignments and the first job's start.
endDate string no The employment end date. Use format YYYY-MM-DD. It cannot be cleared through this endpoint. Setting it on a previously open-ended employment also end-dates the person's active jobs and open absence policy assignments to the same date.
employmentCategory string no The person's employment category.
address object no The person's home address. When present it replaces the whole address, not a per-field patch.
address.line1 string yes The first address line: street number and name, or PO box.
address.line2 string no The second address line: apartment, suite, unit, building or floor.
address.city string yes The city or locality.
address.country string yes The country. Format ISO 3166-1 alpha-2, for example 'US'.
address.stateProvince string no The state, province or region.
address.zipCode string yes The postal or ZIP code.
createExternalIdentifiers array of object no The external identifiers to add. A fieldName already present on the record fails with DUPLICATE_EXTERNAL_IDENTIFIER, because adding a duplicate key is not an implicit update.
createExternalIdentifiers[].fieldName string yes The configured key of the external identifier, a camelCase slug such as 'netsuiteEmployeeId'. It must be the fieldName of an existing employee external-identifier configuration, or the call fails with UNKNOWN_EXTERNAL_IDENTIFIER.
createExternalIdentifiers[].value string yes The identifier as the source system holds it.
createExternalIdentifiers[].externalUrl string no An absolute http(s) link to the object in the source system.
updateExternalIdentifiers array of object no The external identifiers to rewrite, matched by fieldName. A fieldName not already present fails with EXTERNAL_IDENTIFIER_NOT_FOUND, because rewriting is not an implicit create.
updateExternalIdentifiers[].fieldName string yes The configured key of the external identifier already present on the record.
updateExternalIdentifiers[].value string yes The new identifier value.
updateExternalIdentifiers[].externalUrl string no An absolute http(s) link to the object in the source system.
deleteExternalIdentifiers array of string no The fieldNames of external identifiers to remove. A fieldName not present on the record fails with EXTERNAL_IDENTIFIER_NOT_FOUND. Omit all three external-identifier arrays to leave the set unchanged, since deletion is always explicit.

Example:

{
  "firstName": "<firstName>",
  "lastName": "<lastName>",
  "middleName": "<middleName>",
  "email": "<email>",
  "personalEmail": "<personalEmail>",
  "gender": "<gender>",
  "dateOfBirth": "<dateOfBirth>",
  "nationality": "<nationality>",
  "startDate": "<startDate>",
  "endDate": "<endDate>",
  "employmentCategory": "<employmentCategory>",
  "address": {
    "line1": "<line1>",
    "line2": "<line2>",
    "city": "<city>",
    "country": "<country>",
    "stateProvince": "<stateProvince>",
    "zipCode": "<zipCode>"
  },
  "createExternalIdentifiers": [
    {
      "fieldName": "<fieldName>",
      "value": "<value>",
      "externalUrl": "<externalUrl>"
    }
  ],
  "updateExternalIdentifiers": [
    {
      "fieldName": "<fieldName>",
      "value": "<value>",
      "externalUrl": "<externalUrl>"
    }
  ],
  "deleteExternalIdentifiers": [
    "<deleteExternalIdentifiers>"
  ]
}

Response

200 Success

Response headers

Errors

Code Status
NOT_FOUND 400
UNKNOWN_EXTERNAL_IDENTIFIER 400
DUPLICATE_EXTERNAL_IDENTIFIER 400
EXTERNAL_IDENTIFIER_NOT_FOUND 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses