PUT Request to Plans

This page notes the requirements for sending a PUT request to a plan in the Ideon API. This request allows changes to a created Plan, with the exception of certain elements.

Ideon
Provide?
Usage and Mapping

external_identifier*

Required, can be Updated

This is an identifier that your system can use or generate to identify the plan. This is in addition to our id that we generate upon creation.

description*

Required,

can be Updated

This is the description of a given plan - This is often the Plan Marketing Name displayed to an employee when electing the plan option.

product_line*

Required, cannot be updated in PUT

This is the Product Line of the given plan option - Values:

  • medical

  • dental

  • vision

  • life

  • accidental_death_dismemberment

  • life_accidental_death_dismemberment

  • accident

  • critical_illness

  • hospital_indemnity

  • disability

For some product lines, the fields below are required in a PUT request (similar to our POST request requirements

Ideon
Usage and Mapping

product_type

Required, cannot be updated in PUT

Required for:

  • medical - values

    • health_maintenance_organization,

    • high_deductible_health_plan,

    • preferred_provider_organization,

    • exclusive_provider_organization,

    • point_of_service,

    • indemnity

  • disability - values

    • short_term,

    • long_term

premium_level

Required, can be Updated

Required for:

  • dental

  • vision

values: base, buyup, none

voluntary

Required, cannot be updated in PUT

  • critical illness

  • hospital_indemnity

  • life

  • life_accidental_death_dismemberment

  • accidental_death_dismemberment

  • disability

covered_member_types

Required, can be Updated

  • life

  • life_accidental_death_dismemberment

  • accidental_death_dismemberment

  • disability

Values: employee, partner, child

See Additional Documentation for links to our current API documentation.

Last updated

Was this helpful?