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

Update employer settings

employers.update_settings(stremployer_id, EmployerUpdateSettingsParams**kwargs) -> EmployerUpdateSettingsResponse
PUT/v1/employers/{employer_id}/settings

Updates configuration settings for a specific employer. The employer must belong to the authenticated organization.

ParametersExpand Collapse
employer_id: str

Unique employer identifier (empr_*)

pay_frequency: Literal["weekly", "bi_weekly", "semi_monthly", "monthly"]
  • weekly - weekly
  • bi_weekly - bi_weekly
  • semi_monthly - semi_monthly
  • monthly - monthly
One of the following:
"weekly"
"bi_weekly"
"semi_monthly"
"monthly"
ReturnsExpand Collapse
class EmployerUpdateSettingsResponse: …

Response containing a single employer settings resource.

data: Data
pay_frequency: Optional[Literal["weekly", "bi_weekly", "semi_monthly", "monthly"]]
  • weekly - Weekly
  • bi_weekly - Bi-Weekly
  • semi_monthly - Semi-Monthly
  • monthly - Monthly
One of the following:
"weekly"
"bi_weekly"
"semi_monthly"
"monthly"

Update employer settings

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
)
response = client.employers.update_settings(
    employer_id="empr_abc123def456",
    pay_frequency="bi_weekly",
)
print(response.data)
{
  "data": {
    "pay_frequency": "bi_weekly"
  }
}
Returns Examples
{
  "data": {
    "pay_frequency": "bi_weekly"
  }
}