Update an employee's home address
PUT {{baseUrl}}/v1/home_addresses/:home_address_uuid
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
Request Body
{"version"=>"<string>", "street_1"=>"<string>", "street_2"=>"<string>", "city"=>"<string>", "state"=>"<string>", "zip"=>"<string>", "effective_date"=>"<date>", "courtesy_withholding"=>"<boolean>"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-Gusto-API-Version | string | Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used. | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"uuid":"56260b3d-c375-415c-b77a-75d99f717193","employee_id":12345,"street_1":"644 Fay Vista","street_2":"Suite 842","city":"Richmond","state":"VA","zip":"23218","country":"USA","active":false,"effective_date":"2021-01-01","courtesy_withholding":true}