Update employer

client.employers.update(, ?, ?): Employer { id, active, created_at, 7 more }

put/v1/employers/{employer_id}

Updates an existing employer's information. All fields are optional - only provided fields will be updated. Note: EIN cannot be changed after creation.

ParametersExpand Collapse

employerID: string

body: EmployerUpdateParams { active, address, legal_name, name }

active?: boolean | null

Whether the employer is active

address?: Address | null

Employer address

city: string

City name

state: string

Two-letter state code

maxLength2

minLength2

street_1: string

Primary street address

zip_code: string

ZIP code

country?: string

Country code

street_2?: string | null

Secondary street address

legal_name?: string | null

Legal business name

maxLength255

minLength1

name?: string | null

Employer display name

maxLength255

minLength1

ReturnsExpand Collapse

Employer { id, active, created_at, 7 more }

Serializer for Employer entity in public API responses.

Matches EmployerEntity from company module domain.

id: string

Unique employer identifier with 'empr_' prefix

active: boolean

Whether the employer is currently active in the system

created_at: string

Timestamp when the employer was created

formatdate-time

legal_name: string

Legal business name for compliance and tax purposes

name: string

Display name of the employer

organization_id: string

ID of the parent organization (org_*)

updated_at: string

Timestamp when the employer was last updated

formatdate-time

address?: Address | null

Nested address within EmployerSerializer.

city: string

City name

state: string

Two-letter state code (e.g., CA, NY)

street_1: string

Primary street address

zip_code: string

ZIP code (5 or 9 digit)

country?: string

Country code (default: US)

street_2?: string | null

Secondary street address (apt, suite, etc.)

ein?: string | null

Employer Identification Number (masked in responses)

eligibility_policy_id?: string | null

ID of the benefit eligibility policy (epol_*), if assigned

Update employer

import VitableConnectAPI from 'vitable-connect-api';

const client = new VitableConnectAPI({
  apiKey: 'My API Key',
});

const employer = await client.employers.update('empr_abc123def456');

console.log(employer.id);

{
  "id": "id",
  "active": true,
  "created_at": "2019-12-27T18:11:19.117Z",
  "legal_name": "legal_name",
  "name": "name",
  "organization_id": "organization_id",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "address": {
    "city": "city",
    "state": "state",
    "street_1": "street_1",
    "zip_code": "zip_code",
    "country": "country",
    "street_2": "street_2"
  },
  "ein": "ein",
  "eligibility_policy_id": "eligibility_policy_id"
}

Returns Examples

{
  "id": "id",
  "active": true,
  "created_at": "2019-12-27T18:11:19.117Z",
  "legal_name": "legal_name",
  "name": "name",
  "organization_id": "organization_id",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "address": {
    "city": "city",
    "state": "state",
    "street_1": "street_1",
    "zip_code": "zip_code",
    "country": "country",
    "street_2": "street_2"
  },
  "ein": "ein",
  "eligibility_policy_id": "eligibility_policy_id"
}