Work address

Associate the employee’s work location for employees that are not working from home.

If an employee is set to work from home with work_from_home set to true in the home_address object, it is not valid to pass a work_address. See the Home address for more information.

Scope: scope: employees:manage

Prerequisites

The work location must first exist at the company level to create an employee’s work address. This is the location_uuid that you’ll provide as a work address.

If it does not exist, you’ll need to create a company location using the POST /v1/companies/{company_id}/locations endpoint.

Example

bash

{
  "idempotency_key": "bcfc9744-0ab3-4ef3-ab0d-e728255d659c",
  "batch_action" : "create",
  "batch": [
    {
      "entity_type": "employee",

      "person": {
        "external_id": "employee-abc-123",
        "first_name": "Alice",
        "last_name": "Smith"
      },
      "work_address": {
        "location_uuid": "6fd76a95-a887-428c-8cc1-5eb6160af092"
      }
    }
  ]
}

Check here to see how this looks in the context of a full batch example.

---

Home address

Job