v1

latestOpenAPI 3.1.02026-07-243113441.2 MB

Employee Addresses

Update an employee's home address

The home address of an employee is used to determine certain tax information about them. Addresses are geocoded on create and update to ensure validity.

Supports home address effective dating and courtesy withholding.

scope: employees:write

put/v1/home_addresses/{home_address_uuid}

Path parameters

home_address_uuidstring required

The UUID of the home 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.

street_1string

street_2string nullable

citystring

statestring

zipstring

effective_datestring date nullable

courtesy_withholdingboolean

Example request

{
  "version": "56d00c178bc7393b2a206ed6a86afcb4"
}

Response

successful

uuidstring required

The UUID of the employee address

employee_uuidstring

The UUID of the employee

effective_datestring date

The date the employee started living at the address.

courtesy_withholdingboolean

Determines if home taxes should be withheld and paid for employee.