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

Update employer

employers.update(stremployer_id, EmployerUpdateParams**kwargs) -> EmployerResponse
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: str

Unique employer identifier (empr_*)

active: Optional[bool]

Whether the employer is active

address: Optional[Address]

Employer address

address_line_1: str

Primary street address

city: str

City name

state: str

Two-letter state code

maxLength2
minLength2
zipcode: str

ZIP code

address_line_2: Optional[str]

Secondary street address

name: Optional[str]

Employer display name

maxLength255
minLength1
ReturnsExpand Collapse
class EmployerResponse: …

Response containing a single employer resource.

data: Employer

Serializer for Employer entity in public API responses.

id: str

Unique employer identifier with ‘empr_’ prefix

active: bool

Whether the employer is currently active in the system

address: Address

Nested address within EmployerSerializer.

address_line_1: str

Primary street address

city: str

City name

state: str

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

zipcode: str

ZIP code (5 or 9 digit)

address_line_2: Optional[str]

Secondary street address (apt, suite, etc.)

contact: Optional[Contact]

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

email: Optional[str]

Primary contact email

formatemail
phone: Optional[str]

Primary contact phone, or null

created_at: datetime

Timestamp when the employer was created

formatdate-time
ein: Optional[str]

Employer Identification Number (format: XX-XXXXXXX)

name: str

Display name of the employer

organization_id: Optional[str]

ID of the parent organization (org_*)

updated_at: datetime

Timestamp when the employer was last updated

formatdate-time
email: Optional[str]

Email address for billing and communications

formatemail
phone_number: Optional[str]

Employer phone number (E.164 format recommended)

reference_id: Optional[str]

Partner-assigned reference ID for the employer

Update employer

import os
from vitable_connect import VitableConnect

client = VitableConnect(
    api_key=os.environ.get("VITABLE_CONNECT_API_KEY"),  # This is the default and can be omitted
)
employer_response = client.employers.update(
    employer_id="empr_abc123def456",
)
print(employer_response.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"
  }
}