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

Create eligibility policy

employers.create_benefit_eligibility_policy(employer_id, **kwargs) -> BenefitEligibilityPolicyResponse { data }
POST/v1/employers/{employer_id}/benefit-eligibility-policies

Creates a benefit eligibility policy for the specified employer.

ParametersExpand Collapse
employer_id: String

Unique employer identifier (empr_*)

classification: String

Which employee classifications are eligible. One of: full_time, part_time, all

waiting_period: String

Waiting period before eligibility. One of: first_of_following_month, 30_days, 60_days, none

ReturnsExpand Collapse
class BenefitEligibilityPolicyResponse { data }

Response containing a single benefit eligibility policy resource.

data: BenefitEligibilityPolicy { id, active, classification, 4 more }
id: String
active: bool
classification: String
created_at: Time
formatdate-time
employer_id: String
updated_at: Time
formatdate-time
waiting_period: String

Create eligibility policy

require "vitable_connect"

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

benefit_eligibility_policy_response = vitable_connect.employers.create_benefit_eligibility_policy(
  "empr_abc123def456",
  classification: "classification",
  waiting_period: "waiting_period"
)

puts(benefit_eligibility_policy_response)
{
  "data": {
    "id": "id",
    "active": true,
    "classification": "classification",
    "created_at": "2019-12-27T18:11:19.117Z",
    "employer_id": "employer_id",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "waiting_period": "waiting_period"
  }
}
Returns Examples
{
  "data": {
    "id": "id",
    "active": true,
    "classification": "classification",
    "created_at": "2019-12-27T18:11:19.117Z",
    "employer_id": "employer_id",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "waiting_period": "waiting_period"
  }
}