Skip to main content
POST
Create a benefit event
Open an enrollment window against a program. Provide an entity for an entity-wide open enrollment, or a worker for a new-hire or QLE event — exactly one is required.

Parameters

string
required
ID of the program the window opens into.
string
required
What opens the window. One of open_enrollment, new_hire, qle, or termination.
string
required
The event point — the hire or QLE date, or the open-enrollment effective date.
string
ID of the entity, for an entity-wide open enrollment. Required unless worker is set.
string
ID of the worker, for a new-hire or QLE event. Required unless entity is set.
string
For a qle, the qualifying reason — e.g. marriage, newborn, divorce, adoption, lost_coverage.
string
First day the enrollment window is open.
string
Last day the enrollment window is open.
object
Set of key-value pairs attached to the event.

Returns

Returns the created Benefit event object.