---
title: "Update Employee"
method: POST
path: "/v1/update-employee"
tags: ["Employee (v1)"]
---

# Update Employee

`POST /v1/update-employee`

## Request

- Base URL: `https://dc1demogw.paylocity.com/api`
- URL: `https://dc1demogw.paylocity.com/api/v1/update-employee`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.paylocity.com/IdentityServer/connect/token` scopes: `WebLinkAPI`

Update Employee API sends updates to employee data to Paylocity Payroll/HR solution.
 
> 🚧 Maintenance Mode
> 
> _This resource version is in a limited support mode and should not be used for new integrations.  Please use the latest version._

## Headers

- `Authorization` string, required

## Request body

- object
  - `updateEmployee` UpdateEmployee
    - `address1` string: Employee home 1st address line. <br />Max length: 40
    - `address2` string: Employee home 2nd address line. <br />Max length: 40
    - `adjSeniorityDate` string, date: Adjusted seniority date. Common formats are *MM-DD-CCYY, CCYY-MM-DD*.
    - `birthDate` string, date: Employee birthdate. Common formats are *MM-DD-CCYY, CCYY-MM-DD*.
    - `city` string: Employee home city. <br />Max length: 40
    - `companyNumber` string: Paylocity assigned company number. <br /> Max length: 9
    - `country` string: Employee country. <br /> Max length: 30
    - `county` string: Employee county.<br /> Max length: 30
    - `disability` string: Indicates if employee has disability status.
    - `eligibleForRehire` boolean: Indicates if employee eligible for rehire.
    - `employeeId` string: The Paylocity Employee ID. This is a unique value per Paylocity Company ID. **Allowable Values:** 10 char max
    - `employeeStatus` string: Employee current work status. Common values are *A* (Active), *L* (Leave of Absence), *T* (Terminated). <br />Max length: 20
    - `empStatusChangeReason` string: Employee status change reason. Must match Company setup.<br />Max length: 15
    - `empStatusEffectiveDate` string: Effective date of employee status change, can be in the future. Common formats are *MM-DD-CCYY, CCYY-MM-DD*.
    - `ethnicity` string: Employee ethnicity.<br /> Max length: 10
    - `firstName` string: Employee first name. <br />Max length: 40
    - `homePhone` string: Employee home phone number. <br />Max length: 12
    - `lastName` string: Employee last name. <br />Max length: 40
    - `maritalStatus` string: Employee marital status. Common values *D (Divorced), M (Married), S (Single), W (Widowed)*. <br />Max length: 10
    - `middleName` string: Employee middle name.<br /> Max length: 20
    - `nickname` string: Employee preferred display name. <br /> Max length: 20
    - `pager` string: Employee work pager number.<br /> Max length: 20
    - `personalEmailAddress` string: Employee personal email address. <br />Max length: 50
    - `personalMobilePhone` string: Employee personal mobile phone number. <br />Max length: 12
    - `priorLastName` string: Prior last name if applicable.<br />Max length: 40
    - `salutation` string: Employee preferred salutation. <br />Max length: 10
    - `sex` string: Employee gender. Common values *M* (Male), *F* (Female). <br />Max length: 1
    - `smoker` boolean: Indicates if employee is a smoker.
    - `ssn` string: Employee social security number. Leave it blank if valid social security number not available. <br />Max length: 11
    - `state` string: Employee home state. <br />Max length: 2
    - `suffix` string: Employee name suffix. Common values are *Jr, Sr, II*.<br />Max length: 30
    - `suiExempt` boolean: Indicates if employee is exempt from state unemployment insurance.
    - `suiExemptNotes` string: Notes for SUI exempt.<br /> Max length: 250
    - `suiExemptReason` string: Reason code for SUI exemption. Common values are *SE* (Statutory employee), *CR* (Clergy/Religious). <br /> Max length: 30
    - `veteran` string: Indicates if employee is a veteran.
    - `workAddress1` string: Employee work 1st address line.<br /> Max length: 40
    - `workAddress2` string: Employee work 2nd address line. <br /> Max length: 40
    - `workCity` string: Employee work city.<br /> Max length: 40
    - `workCountry` string: Employee work country.<br /> Max length: 30
    - `workCounty` string: Employee work county.<br /> Max length: 30
    - `workEmailAddress` string: Employee work email. <br />Max length: 50
    - `workMailStop` string: Employee physical mail box location.<br /> Max length: 10
    - `workMobilePhone` string: Employee work mobile phone number.<br /> Max length: 12
    - `workPager` string: Employee work pager number.<br /> Max length: 20
    - `workPhone` string: Employee work phone number.<br /> Max length: 12
    - `workPhoneExt` string: Employee work phone extension number.<br /> Max length: 10
    - `workState` string: Employee work state.<br /> Max length: 2
    - `workZip` string: Employee work zip code.<br /> Max length: 10
    - `zip` string: Employee home zip code. <br />Max length: 10
    - `benefitSetup` BenefitSetup[]: benefitSetup
      - `benefitClass` string: Benefit Class code. Values are configured in Paylocity Payroll/HR solution Company > Setup > Benefits > Classes.<br />Max length: 30
      - `benefitClassEffectiveDate` string, paylocity-date: Date when Benefit Class takes effect. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
      - `benefitSalary` number: Salary used to configure benefits.<br />Decimal(12,2)
      - `benefitSalaryEffectiveDate` string, paylocity-date: Date when Benefit Salary takes effect. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
      - `doNotApplyAdministrativePeriod` boolean: Applicable only for HR Enhanced clients and Benefit Classes with ACA Employment Type of Full Time.
      - `isMeasureAcaEligibility` boolean: Only valid for HR Enhanced clients and Benefit Classes that are ACA Employment Type of Full Time.
    - `departmentPosition` DepartmentPosition[]: departmentPosition
      - `changeReason` string: Employee department/position change reason. Must match Company setup.<br />Max length: 15
      - `clockBadgeNumber` string: Employee clock badge number. Defaults to employeeId. <br />Max length: 10
      - `costCenter1` string: Employer defined location, like *branch, division, department*, etc. Must match Company setup. <br />Max length: 10
      - `costCenter2` string: Employer defined location, like *branch, division, department*, etc. Must match Company setup. <br />Max length: 10
      - `costCenter3` string: Employer defined location, like *branch, division, department*, etc. Must match Company setup. <br />Max length: 10
      - `effectiveDate` string, date: The date the position takes effect. (MM-DD-CCYY)
      - `employeeType` string: Employee current employment type. Common values *RFT (Regular Full Time), RPT (Regular Part Time), SNL (Seasonal), TFT (Temporary Full Time), TPT (Temporary Part Time)*. <br />Max length: 10
      - `equalEmploymentOpportunityClass` string: Values are configured in Company > Setup > HR > EEO Classes.<br /> Max length: 10
      - `isSupervisorReviewer` boolean: Indicates if employee is a supervisor or reviewer.
      - `jobTitle` string: Employee current job title. <br />Max length: 50
      - `minimumWageExempt` boolean: Indicates if employee is exempt from minimum wage.
      - `overtimeExempt` boolean: Indicates if employee is exempt from overtime.
      - `payGroup` string: Employee pay group. Must match Company setup. <br /> Max length: 20
      - `positionCode` string: Employee position code. Must match Company setup.<br />Max length: 20
      - `shift` string: Employee work shift.<br />Max length: 255
      - `supervisorCompanyNumber` string: Supervisor's company number. Defaults to employee company number.<br />Max length: 9
      - `supervisorEmployeeId` string: EmployeeId of the supervisor. <br />Max length: 10
      - `tipped` string: Indicates if employee receives tips.
      - `unionAffiliationDate` string, date: Employee union affiliation effective date. Common formats are *MM-DD-CCYY, CCYY-MM-DD*.
      - `unionCode` string: Employee union code. Must match Company setup. <br />Max length: 10
      - `unionDuesCollected` boolean: Indicates if union dues are collected.
      - `unionInitiationCollected` boolean: Indicates if union initiation fees are collected
      - `unionPosition` string: Employee union position. Must match Company setup. <br />Max length: 30
      - `workersComp` string: Employee worker compensation code. Must match Company setup.<br /> Max length: 10
    - `primaryPayRate` PrimaryPayRate[]: primaryPayRate
      - `autoPay` boolean: If set to *True*, employee will be paid automatically using defaultHours.
      - `baseRate` number: Employee base rate, used for Hourly employees. <br />Decimal (12,2)
      - `defaultHours` number: Employee default hours consistently worked. If autoPayType is set to D, employee will be paid hourly base rate for the defaultHours. <br />Decimal (12,2)
      - `effectiveDate` string, date: The date the employee’s pay rate takes effect. Common formats are *MM-DD-CCYY, CCYY-MM-DD*.
      - `payFrequency` string: Employee current pay frequency. Common values are *A (Annual), B (Bi-Weekly), D (Daily), M (Monthly), S (Semi-Monthly), Q (Quarterly), W (Weekly)*. <br />Max length: 5
      - `payGrade` string: Employee pay grade. Must match Company setup. <br /> Max length: 10
      - `payType` string: Employee pay type (rate code). Valid values are *Hourly* or *Salary*. <br />Max length: 10
      - `ratePer` string: Employee base rate frequency used with payType Hourly. Common values are *Hour, Week*. Default is Hour. <br />Max length: 10
      - `reason` string: Primary Pay Rate change reason. Must match Company setup.<br />Max length: 15
      - `salary` number: Employee gross salary per pay period used with payType Salary.<br />Decimal (12,2)
    - `webTime` WebTime[]: webTime
      - `syncWebTimeRecord` boolean: UpdateEmployeePreferences.SyncWebTimeRecord

## Response `200`

Successfully updated

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `500`: Internal Server Error

---

[API](https://skmtc.dev/paylocity/apis/weblink-api.md) - [All operations](https://skmtc.dev/paylocity/apis/weblink-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paylocity/apis/weblink-api/revisions/8152ed40b412?raw)