Skip to main content
POST
/
v1
/
company-benefits
/
{company_benefit_id}
/
configuration
Configure company benefit
curl --request POST \
  --url https://api.vitablehealth.com/v1/company-benefits/{company_benefit_id}/configuration \
  --header 'Content-Type: application/json' \
  --header 'X-Partner-API-Key: <api-key>' \
  --data '
{
  "min_monthly_premium_in_cents": 1,
  "open_enrollment_start_date": "2023-12-25",
  "configured_eligibility_rules": [
    {
      "employment": "Unspecified",
      "compensation": "Unspecified",
      "location": "Unspecified",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "location_value": "<string>"
    }
  ],
  "configured_tier_costs": [
    {
      "tier_cost_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cost_in_cents": 1,
      "cost_per_dependent_in_cents": 1,
      "pepm_in_cents": 1,
      "pepm_per_dependent_in_cents": 1
    }
  ],
  "selected_eligible_expense_categories_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "open_enrollment_end_date": "2023-12-25",
  "agency_of_record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{}

Authorizations

X-Partner-API-Key
string
header
required

Partner API key for external integrations

Path Parameters

company_benefit_id
string<uuid>
required

Unique identifier for the company benefit to configure

Body

application/json

Request to configure a company benefit

min_monthly_premium_in_cents
integer
required

Minimum monthly premium amount in cents

Required range: x >= 0
open_enrollment_start_date
string<date>
required

Open enrollment period start date

configured_eligibility_rules
object[]
required

Eligibility rules configuration

configured_tier_costs
object[]
required

Tier cost configuration

selected_eligible_expense_categories_ids
string<uuid>[]
required

Selected eligible expense category IDs

open_enrollment_end_date
string<date> | null

Open enrollment period end date

agency_of_record_id
string<uuid> | null

Agency of record identifier

Response

200

Company benefit configured successfully