Deel: Update worker address by type
Deel people.updateWorkerAddressByType: arguments, response, policy and SDK examples.
← People operations · Get started
Operation deel.people_updateworkeraddressbytype_v2026_10_28
Provider route: PATCH /people/{worker_id}/addresses/{address_type}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["people"]["updateWorkerAddressByType"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.people.updateWorkerAddressByType(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.people.update_worker_address_by_type(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.worker_id | string | Required within parent | Format: uuid |
path.address_type | string | Required within parent | One of: HOME, POSTAL |
headers | object | Required within parent | Additional keys: not allowed |
headers.X-Beta | string | Required within parent | Default: true One of: true |
body | object | Optional | |
body.data | Model | Required within parent | Expand Update worker address by type — request body — body data Address fields to change, with optional effective date and edit reason. |
Referenced models: Update worker address by type — request body — body data
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Update worker address by type — 200 response body |
Referenced models: Update worker address by type — 200 response body
Schemas
Section titled “Schemas”Update worker address by type — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Update worker address by type — 200 response body — data The address version written by the request. |
Referenced models: Update worker address by type — 200 response body — data
Update worker address by type — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Address fields to change, with optional effective date and edit reason. |
city | string or null | Optional | The city. |
country | string | Optional | The two-letter country code. Required when the address is created; cannot be null. |
edit_reason | JSON | Optional | Reason recorded with the change. |
edit_reason (oneOf 1) | Model | Alternative | Expand Update worker address by type — request body — body data edit reason Reason recorded with the change |
edit_reason (oneOf 2) | null | Alternative | |
effective_date | string | Optional | Date (YYYY-MM-DD) from which the change applies; a future date schedules it. Format: date |
line_two | string or null | Optional | The second address line. |
state | string or null | Optional | The state. |
street | string or null | Optional | The street address. |
zip | string or null | Optional | The zip code. |
Referenced models: Update worker address by type — request body — body data edit reason Reason recorded with the change
Update worker address by type — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The address version written by the request. |
city | JSON | Required within parent | |
city (anyOf 1) | string | Alternative | The city. |
city (anyOf 2) | null | Alternative | The city. |
country | string | Required within parent | The two-letter country code. |
effective_date | JSON | Required within parent | |
effective_date (anyOf 1) | string | Alternative | Date (YYYY-MM-DD) from which this version of the address applies. Format: date |
effective_date (anyOf 2) | null | Alternative | Date (YYYY-MM-DD) from which this version of the address applies. Format: date |
id | string | Required within parent | Unique identifier of the address. Format: uuid |
line_two | JSON | Required within parent | |
line_two (anyOf 1) | string | Alternative | The second address line. |
line_two (anyOf 2) | null | Alternative | The second address line. |
state | JSON | Required within parent | |
state (anyOf 1) | string | Alternative | The state. |
state (anyOf 2) | null | Alternative | The state. |
street | JSON | Required within parent | |
street (anyOf 1) | string | Alternative | The street address. |
street (anyOf 2) | null | Alternative | The street address. |
type | string | Required within parent | The type of the address. Known values: HOME, POSTAL |
zip | JSON | Required within parent | |
zip (anyOf 1) | string | Alternative | The zip code. |
zip (anyOf 2) | null | Alternative | The zip code. |
Update worker address by type — request body — body data edit reason Reason recorded with the change
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Reason recorded with the change. |
additional_info | string or null | Optional | Free-text details about the change. Maximum length: 2000 |
reason_oid | string | Optional | Public id of the edit reason. Format: uuid |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.people_updateworkeraddressbytype_v2026_10_28. Catalog operation: people_updateworkeraddressbytype_v2026_10_28. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["people:write"]
Pinned headers: {"X-Version": "2026-10-28"}