Employers

Update employer settings

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

put/v1/employers/{employer_id}/settings

Request

  • Base URL: https://api.vitablehealth.com
  • URL: https://api.vitablehealth.com/v1/employers/{employer_id}/settings
  • Auth: HTTP bearer

Path parameters

employer_idstring required

Unique employer identifier (empr_*)

Headers

X-Vitable-Organizationstring

Organization to act as for this request (e.g. org_SGVsbG8gV29ybGQ). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 organization_required. A malformed value returns 400 invalid_organization_header, and naming an organization you do not have access to returns 403 organization_access_denied.

Request body

pay_frequency'weekly' | 'bi_weekly' | 'semi_monthly' | 'monthly' required
  • weekly - Weekly
  • bi_weekly - Bi Weekly
  • semi_monthly - Semi Monthly
  • monthly - Monthly

Response

Changes

No recorded changes to this operation across all 1 revision of this API.