Update employee address

Updates the authenticated employee's residential address.

The employment is derived from the access token's subject — there is no
employment id in the path. The token must be an employee-role token
(typically obtained via the OAuth2 assertion grant with subject
urn:remote-api:employee:employment:<employment_id>).

This endpoint requires country-specific data. The exact required fields vary depending on which
country the authenticated employee's employment is in. Query the
Show form schema endpoint with address_details
as the form name to discover the schema for a given country.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)-Manage addresses (address:write)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
≥ 1

Version of the address_details form schema


Specific version number

Body Params

Employee address details params

Employment address details params.

address_details
object
required

Home address information. As its properties may vary depending on the country,
you must query the Show form schema endpoint
passing the country code and address_details as path parameters.

Responses

Callback
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json