Update employer

employers.update(employer_id, **kwargs) -> 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

employer_id: String

Unique employer identifier (empr_*)

active: bool

Whether the employer is active

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

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

Secondary street address

legal_name: String

Legal business name

maxLength255

minLength1

name: String

Employer display name

maxLength255

minLength1

ReturnsExpand Collapse

class 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: bool

Whether the employer is currently active in the system

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

Secondary street address (apt, suite, etc.)

contact: { email, phone}

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

email: String

Primary contact email

formatemail

phone: String

Primary contact phone, or null

created_at: Time

Timestamp when the employer was created

formatdate-time

ein: String

Employer Identification Number (format: XX-XXXXXXX)

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: Time

Timestamp when the employer was last updated

formatdate-time

email: String

Email address for billing and communications

formatemail

phone_number: String

Employer phone number (E.164 format recommended)

reference_id: String

Partner-assigned reference ID for the employer

Update employer

require "vitable_connect"

vitable_connect = VitableConnect::Client.new(
  api_key: "My API Key",
  environment: "environment_1" # defaults to "production"
)

employer_response = vitable_connect.employers.update("empr_abc123def456")

puts(employer_response)

{
  "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"
  }
}