Skip to main content
PATCH
Update a worker address

Parameters

string
required
ID of the worker address to update.
string
Correct this worker address so it points at another place already referenced by the same worker’s addresses.
boolean
deprecated
Deprecated and ignored. Every PATCH to a worker address is a correction: it changes what the existing record claims, never records a new address.
date
Correct the date this worker address became effective.
date
Correct the date this worker address stopped being effective.
string
Correct address line 1.
string
Correct address line 2.
string
Correct city.
string
Correct state, province, or subdivision.
string
Correct postal code.
string
Correct two-letter country code.

Returns

Returns the updated Worker address object.
Use POST /v1/worker-addresses when the worker has moved or a new effective row should be created. Use PATCH only when the existing row or place reference was recorded incorrectly — every PATCH is a correction. Field corrections update the shared place and affect every worker address and location that points at it.
Date corrections cascade to the adjacent record. When the corrected date is a boundary shared with the previous or next address of the same purpose, that record’s matching date moves with it.