Skip to main content
POST
Create a worker address

Parameters

string
required
ID of the worker this address belongs to.
string
required
Address purpose. One of residential, business, or shipping.
string
Existing place ID from one of this worker’s addresses. Use this to make two purposes point at the same place, such as shipping to the residential address.
string
Effective start date. Omit when the address was effective before Plane tracked the worker’s address history.
string
Address line 1. Provide address fields when you are not using place.
string
Address line 2.
string
City.
string
State, province, or subdivision, when applicable.
string
Postal code.
string
Two-letter country code.

Returns

Returns the created Worker address object. When a value-based request exactly matches a place already referenced by this worker’s addresses, Plane reuses that place and returns its ID in place. When an address records a successor row for the same purpose, Plane immediately writes the previous row’s ends as the day before the new row’s starts, even if the successor starts in the future.