Updates the employee's W-2 contact name and mailing address.

Access: System, Admin, and ClientAdmin users with AdvanceAccess.ChangeW2Address.

This updates tax-form delivery data used for W-2 generation. It does not accept or change the W-2 electronic-delivery consent flag.

The W-2 mailing address is saved without payroll/STE validation, normalization, or an AddressFix_v10 correction round-trip; only structural model validation is applied.

Required address fields: addressLine1, addressCity, addressZIP and addressCountry are always required; addressState is required only when addressCountry is one of US, CA, MX (the countries-with-states list). middleName, suffix and addressLine2 are optional.

Request example:

{
  "firstName": "Jane",
  "middleName": "A",
  "lastName": "Employee",
  "suffix": "Jr",
  "address": {
    "addressLine1": "123 Main St",
    "addressLine2": "Suite 100",
    "addressCity": "Denver",
    "addressState": "CO",
    "addressZIP": "80202",
    "addressCountry": "US"
  }
}
            

Successful response example:

{
  "electronicOnly": false,
  "firstName": "Jane",
  "middleName": "A",
  "lastName": "Employee",
  "suffix": "Jr",
  "address": {
    "id": 12345,
    "addressLine1": "123 Main St",
    "addressLine2": "Suite 100",
    "addressCity": "Denver",
    "addressState": "CO",
    "addressZIP": "80202",
    "addressCountry": "US"
  },
  "addressId": 12345
}
            
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Identifier of the employee's company from the route.

int32
required

Identifier of the employee whose W-2 contact data should be updated.

Body Params

Payload containing the W-2 name fields and mailing address.

Request payload used to update an employee's W-2 contact name and mailing address.

string | null
required

Employee first name to store on the W-2 delivery record. Required.

string | null

Employee middle name to store on the W-2 delivery record.

string | null
required

Employee last name to store on the W-2 delivery record. Required.

string | null

Employee suffix to store on the W-2 delivery record.

address
object
required

W-2 mailing address payload. Extends the shared Worklio.ApiModels.API.Models.Clients.Address.AddressUpdate_v10 contract and marks the fields that are mandatory for a W-2 contact update as required in the API schema: addressLine1, addressCity, addressZIP and addressCountry are required. addressState is required only when addressCountry is one of US, CA, MX (the countries-with-states list, AddressCountryRules.CountryWIthStates) and is therefore validated at request time rather than marked unconditionally required in the schema. addressLine2 is optional. The address is saved as submitted; no payroll/STE validation, normalization, or ZIP numeric-format check is applied.

Headers
string
Defaults to 1.0

The requested API version

string
Defaults to 1.0

The requested API version

Responses

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