Employments
Employee Address

Update employee address

Changed on

Updates the authenticated employee's residential address.

The address is replaced: optional fields that aren't sent are cleared.

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.

Authentication

This endpoint requires the following token type:

  • Employee-scoped access token (OAuth2Assertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant. See Authentication for partners.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)-Manage addresses (address:write)
put/v1/employee/address

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/employee/address
  • Auth: OAuth 2 (client credentials, token URL /auth/oauth2/token, scopes: address:write, employments, all:write)

Query parameters

integer

Specific version number

OR
'latest'

Use latest version

Version of the address_details form schema

Request body

address_detailsobject 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.

Example request

{
  "address_details": {
    "city": "London",
    "country": "GBR",
    "postal_code": "SW1A 1AA",
    "street": "1 Imaginary Way"
  }
}

Response

Success

Example response

{
  "data": {
    "employment": {
      "contract_origin": "remote_contract",
      "id": "20a72f86-employment-id-9e4942a902ff",
      "personal_details": {},
      "status": "created",
      "type": "employee",
      "updated_at": "2024-01-15T10:30:00Z",
      "user_status": "active"
    }
  }
}

Changes

  • 9410f5f18a91Revision changes
    • warning

      added the new invited enum value to the // response property for the response status

  • be4636f25834Revision changes
    • info

      removed the offboarding enum value from the // response property for the response status