Sign in

v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
Employee Addresses

Update an employee work address

The work address of an employee is used for payroll tax purposes.

scope: employees:manage

put/v1/work_addresses/{work_address_uuid}

Path parameters

work_address_uuidstring required

The UUID of the work address

Headers

X-Gusto-API-Version'2026-06-15'

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Request body

versionstring required

The current version of the object. See the versioning guide for information on how to use this field.

location_uuidstring

Reference to a company location

effective_datestring date

Example request

{
  "version": "56d00c178bc7393b2a206ed6a86afcb4",
  "location_uuid": "6a119be7-b4b0-4e27-aaa0-89d5f2524635",
  "effective_date": "2023-05-15"
}

Response

successful

uuidstring required

The unique identifier of this work address.

effective_datestring

The date the employee began working at this location.

activeboolean

Signifies if this address is the active work address for the current date

location_uuidstring

UUID reference to the company location for this work address.

employee_uuidstring

UUID reference to the employee for this work address.

versionstring required

The current version of the object. See the versioning guide for information on how to use this field.

street_1string
street_2string nullable
citystring
statestring
zipstring
countrystring