Skip to navigation
EndpointsPeople

Update worker address by type

Beta

Partially updates a worker’s home or postal address: only fields sent change; a missing address is created (country required). A future effective_date schedules the change; systems such as Deel IT and PEO payroll are notified when it becomes current. PEO payroll (Prism) sync is asynchronous. Does not change an independent contractor’s legal, invoice or payout address, nor EOR contract documents. GP payroll contract addresses: PATCH /rest/gp/workers/{worker_id}/address. Must be enabled per organization.

Token scopes: people:write

Beta: this version requires the X-Beta: true request header and its contract may change before it is promoted to stable. It is scheduled to become stable on 2027-01-28.

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

OR
AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

worker_idstringRequiredformat: "uuid"
Unique identifier for a worker.
address_typeenumRequired
The type of the address to update.
Allowed values:

Headers

X-BetaenumRequiredDefaults to true

Opts in to the beta version of this endpoint. Must be true.

Allowed values:

Request

The address fields to update.
dataobjectRequired
Address fields to change, with optional effective date and edit reason.

Response

Successful response
dataobject
The address version written by the request.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
412
Precondition Failed Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error