Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.worker_idstringRequired within parentFormat: uuid
path.address_typestringRequired within parentOne of: HOME, POSTAL
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true
bodyobjectOptional
body.dataModelRequired within parentExpand 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 media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Update worker address by type — 200 response body

Referenced models: Update worker address by type — 200 response body

Update worker address by type — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRootAddress fields to change, with optional effective date and edit reason.
citystring or nullOptionalThe city.
countrystringOptionalThe two-letter country code. Required when the address is created; cannot be null.
edit_reasonJSONOptionalReason recorded with the change.
edit_reason (oneOf 1)ModelAlternativeExpand Update worker address by type — request body — body data edit reason Reason recorded with the change
edit_reason (oneOf 2)nullAlternative
effective_datestringOptionalDate (YYYY-MM-DD) from which the change applies; a future date schedules it.
Format: date
line_twostring or nullOptionalThe second address line.
statestring or nullOptionalThe state.
streetstring or nullOptionalThe street address.
zipstring or nullOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRootThe address version written by the request.
cityJSONRequired within parent
city (anyOf 1)stringAlternativeThe city.
city (anyOf 2)nullAlternativeThe city.
countrystringRequired within parentThe two-letter country code.
effective_dateJSONRequired within parent
effective_date (anyOf 1)stringAlternativeDate (YYYY-MM-DD) from which this version of the address applies.
Format: date
effective_date (anyOf 2)nullAlternativeDate (YYYY-MM-DD) from which this version of the address applies.
Format: date
idstringRequired within parentUnique identifier of the address.
Format: uuid
line_twoJSONRequired within parent
line_two (anyOf 1)stringAlternativeThe second address line.
line_two (anyOf 2)nullAlternativeThe second address line.
stateJSONRequired within parent
state (anyOf 1)stringAlternativeThe state.
state (anyOf 2)nullAlternativeThe state.
streetJSONRequired within parent
street (anyOf 1)stringAlternativeThe street address.
street (anyOf 2)nullAlternativeThe street address.
typestringRequired within parentThe type of the address.
Known values: HOME, POSTAL
zipJSONRequired within parent
zip (anyOf 1)stringAlternativeThe zip code.
zip (anyOf 2)nullAlternativeThe zip code.
Update worker address by type — request body — body data edit reason Reason recorded with the change
FieldTypePresenceDescription and constraints
$objectRootReason recorded with the change.
additional_infostring or nullOptionalFree-text details about the change.
Maximum length: 2000
reason_oidstringOptionalPublic id of the edit reason.
Format: uuid

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"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.