v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Set Onboarded Status to True

Set an employee as onboarded.

post/employees/setOnboardedStatusToTrue

Request body

employeeIDstring required

ID of the Employee being updated

companyIDstring required

ID of the employer that the employee belongs to

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "employeeID": "633c323231018d840022913ca6",
    "companyID": "2cb5b29f0792634128c34c1358940c",
    "onboarded": true,
    "employment_status": "live",
    "first_name": "Erlich",
    "last_name": "Bachman",
    "title": "4345",
    "start_date": "2019-11-01",
    "working_state": "CA",
    "workLocationID": "6142deeb548f55223a0c67",
    "dob": "1825-10-02",
    "email": "erlich@test.com",
    "address": "1 Ferry Building",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94105",
    "phone_number": "12345",
    "default_pay_schedule": "weekly",
    "default_wage": 5,
    "default_ot_wage": 100,
    "default_dt_wage": 100,
    "ssn": "000000000",
    "autopilot": {
      "autopilot_on": true,
      "salary": 30000,
      "salary_firstDate": "2022-10-06"
    },
    "is_943": true
  }
}