Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference
Employers

Update employer

client.employers.update(stringemployerID, EmployerUpdateParams { active, address, legal_name, name } body?, RequestOptionsoptions?): EmployerResponse { data }
PUT/v1/employers/{employer_id}

Updates an existing employer. All fields are optional — only provided fields are updated. PO Box addresses are rejected.

ParametersExpand Collapse
employerID: string

Unique employer identifier (empr_*)

body: EmployerUpdateParams { active, address, legal_name, name }
active?: boolean | null

Whether the employer is active

address?: Address | null

Employer address

address_line_1: string

Primary street address

city: string

City name

state: string

Two-letter state code

maxLength2
minLength2
zipcode: string

ZIP code

address_line_2?: string | null

Secondary street address

name?: string | null

Employer display name

maxLength255
minLength1
ReturnsExpand Collapse
EmployerResponse { data }

Response containing a single employer resource.

data: Employer { id, active, address, 10 more }

Serializer for Employer entity in public API responses.

id: string

Unique employer identifier with ‘empr_’ prefix

active: boolean

Whether the employer is currently active in the system

address: Address { address_line_1, city, state, 2 more }

Nested address within EmployerSerializer.

address_line_1: string

Primary street address

city: string

City name

state: string

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

zipcode: string

ZIP code (5 or 9 digit)

address_line_2?: string | null

Secondary street address (apt, suite, etc.)

contact: Contact | null

Primary company-admin contact (email + phone; company admins have no person name).

email: string | null

Primary contact email

formatemail
phone: string | null

Primary contact phone, or null

created_at: string

Timestamp when the employer was created

formatdate-time
ein: string | null

Employer Identification Number (format: XX-XXXXXXX)

name: string

Display name of the employer

organization_id: string | null

ID of the parent organization (org_*)

updated_at: string

Timestamp when the employer was last updated

formatdate-time
email?: string | null

Email address for billing and communications

formatemail
phone_number?: string | null

Employer phone number (E.164 format recommended)

reference_id?: string | null

Partner-assigned reference ID for the employer

Update employer

import VitableConnect from '@vitable-inc/vitable-connect';

const client = new VitableConnect({
  apiKey: process.env['VITABLE_CONNECT_API_KEY'], // This is the default and can be omitted
});

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

console.log(employerResponse.data);
{
  "data": {
    "id": "id",
    "active": true,
    "address": {
      "address_line_1": "address_line_1",
      "city": "city",
      "state": "state",
      "zipcode": "zipcode",
      "address_line_2": "address_line_2"
    },
    "contact": {
      "email": "dev@stainless.com",
      "phone": "phone"
    },
    "created_at": "2019-12-27T18:11:19.117Z",
    "ein": "ein",
    "legal_name": "legal_name",
    "name": "name",
    "organization_id": "organization_id",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "email": "dev@stainless.com",
    "phone_number": "phone_number",
    "reference_id": "reference_id"
  }
}
Returns Examples
{
  "data": {
    "id": "id",
    "active": true,
    "address": {
      "address_line_1": "address_line_1",
      "city": "city",
      "state": "state",
      "zipcode": "zipcode",
      "address_line_2": "address_line_2"
    },
    "contact": {
      "email": "dev@stainless.com",
      "phone": "phone"
    },
    "created_at": "2019-12-27T18:11:19.117Z",
    "ein": "ein",
    "legal_name": "legal_name",
    "name": "name",
    "organization_id": "organization_id",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "email": "dev@stainless.com",
    "phone_number": "phone_number",
    "reference_id": "reference_id"
  }
}