Skip to main content

PatchedStaffUpdate

external_idstringnullable

Possible values: <= 40 characters

name objectnullable

Name fields to update. Omitted fields within this object remain unchanged. Set name to null to clear company-specific name overrides.

first_namestring

Possible values: <= 100 characters

last_namestring

Possible values: <= 100 characters

emailstring<email>nullable
phonestringnullable
birth_datestring<date>nullable
work_eligibility_period objectnullable
startstring<date-time>nullable

UTC timestamp with exactly three fractional-second digits, for example 2026-01-01T00:00:00.000Z.

endstring<date-time>nullable

UTC timestamp with exactly three fractional-second digits, for example 2026-04-01T00:00:00.000Z.

home_location objectnullable
lookup_type ZipcodeLookupLookupTypeEnumrequired

Possible values: [zipcode, city, address]

zipcodestringrequired

Possible values: <= 15 characters

PatchedStaffUpdate
{
  "external_id": "string",
  "name": {
    "first_name": "string",
    "last_name": "string"
  },
  "email": "user@example.com",
  "phone": "string",
  "birth_date": "2024-07-29",
  "work_eligibility_period": {
    "start": "2024-07-29T15:51:28.071Z",
    "end": "2024-07-29T15:51:28.071Z"
  },
  "home_location": {
    "lookup_type": "zipcode",
    "zipcode": "string"
  }
}