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

Update employer settings

employers.update_settings(employer_id, **kwargs) -> EmployerUpdateSettingsResponse { data }
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: String

Unique employer identifier (empr_*)

pay_frequency: :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 { data }

Response containing a single employer settings resource.

data: { pay_frequency}
pay_frequency: :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

require "vitable_connect"

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

response = vitable_connect.employers.update_settings("empr_abc123def456", pay_frequency: :bi_weekly)

puts(response)
{
  "data": {
    "pay_frequency": "bi_weekly"
  }
}
Returns Examples
{
  "data": {
    "pay_frequency": "bi_weekly"
  }
}