Update employer

employers.update(, ) -> Employer

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

employer_id: str

active: Optional[bool]

Whether the employer is active

address: Optional[Address]

Employer address

city: str

City name

state: str

Two-letter state code

maxLength2

minLength2

street_1: str

Primary street address

zip_code: str

ZIP code

country: Optional[str]

Country code

street_2: Optional[str]

Secondary street address

legal_name: Optional[str]

Legal business name

maxLength255

minLength1

name: Optional[str]

Employer display name

maxLength255

minLength1

ReturnsExpand Collapse

class Employer: …

Serializer for Employer entity in public API responses.

Matches EmployerEntity from company module domain.

id: str

Unique employer identifier with 'empr_' prefix

active: bool

Whether the employer is currently active in the system

created_at: datetime

Timestamp when the employer was created

formatdate-time

legal_name: str

Legal business name for compliance and tax purposes

name: str

Display name of the employer

organization_id: str

ID of the parent organization (org_*)

updated_at: datetime

Timestamp when the employer was last updated

formatdate-time

address: Optional[Address]

Nested address within EmployerSerializer.

city: str

City name

state: str

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

street_1: str

Primary street address

zip_code: str

ZIP code (5 or 9 digit)

country: Optional[str]

Country code (default: US)

street_2: Optional[str]

Secondary street address (apt, suite, etc.)

ein: Optional[str]

Employer Identification Number (masked in responses)

eligibility_policy_id: Optional[str]

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

Update employer

from vitable_connect_api import VitableConnectAPI

client = VitableConnectAPI(
    api_key="My API Key",
)
employer = client.employers.update(
    employer_id="empr_abc123def456",
)
print(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"
}