Update an employee's home address

PUT {{baseUrl}}/v1/employees/:employee_id/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.

scope: employees:write

Request Body

{"version"=>"<string>", "street_1"=>"<string>", "street_2"=>"<string>", "city"=>"<string>", "state"=>"<string>", "zip"=>"<string>"}

HEADERS

KeyDatatypeRequiredDescription
X-Gusto-API-VersionstringDetermines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;uuid&quot;:&quot;56260b3d-c375-415c-b77a-75d99f717193&quot;,&quot;employee_id&quot;:12345,&quot;street_1&quot;:&quot;644 Fay Vista&quot;,&quot;street_2&quot;:&quot;Suite 842&quot;,&quot;city&quot;:&quot;Richmond&quot;,&quot;state&quot;:&quot;VA&quot;,&quot;zip&quot;:&quot;23218&quot;,&quot;country&quot;:&quot;USA&quot;,&quot;active&quot;:false,&quot;effective_date&quot;:&quot;2021-01-01&quot;,&quot;courtesy_withholding&quot;:true}