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

Update employer settings

client.employers.updateSettings(stringemployerID, EmployerUpdateSettingsParams { pay_frequency } body, RequestOptionsoptions?): 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
employerID: string

Unique employer identifier (empr_*)

body: EmployerUpdateSettingsParams { 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"
ReturnsExpand Collapse
EmployerUpdateSettingsResponse { data }

Response containing a single employer settings resource.

data: Data { pay_frequency }
pay_frequency: "weekly" | "bi_weekly" | "semi_monthly" | "monthly" | null
  • 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 VitableConnect from '@vitable-inc/vitable-connect';

const client = new VitableConnect({
  apiKey: process.env['VITABLE_CONNECT_API_KEY'], // This is the default and can be omitted
});

const response = await client.employers.updateSettings('empr_abc123def456', {
  pay_frequency: 'bi_weekly',
});

console.log(response.data);
{
  "data": {
    "pay_frequency": "bi_weekly"
  }
}
Returns Examples
{
  "data": {
    "pay_frequency": "bi_weekly"
  }
}