GuidesAPI ReferenceChangelogAPI PolicyAPI StatusGusto Security
API Reference
These docs are for v2023-09-01. Click to read the latest docs for v2024-04-01.

Update an employee work address

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

scope: employees:manage

Path Params
string
required

The UUID of the work address

Body Params
string

Reference to a company location

date
string

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

Headers
string

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

Responses

Response body
object
string
required

The unique identifier of this work address.

string

The date the employee began working at this location.

boolean

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

string

UUID reference to the company location for this work address.

string

UUID reference to the employee for this work address.

string

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

string
string | null
string
string
string
string
Defaults to USA
404

Not Found

The requested resource does not exist. Make sure the provided ID/UUID is valid.

invalid_attribute_value, or the request fails due to an invalid_operation. See the Errors Categories guide for more details.

Language
Credentials