Sign in

v2

latestOpenAPI 3.1.12026-08-0785394779.1 KB
Enrolment Intents

Update policy configuration enrolment intent

Updates the policy configuration for an existing enrolment_intent. This will reset the enrolment intent back to processing status and re-evaluate the enrolment intent based on the new configuration provided.Unavailable for enrolment intents that are already enrolling or enrolled.

put/enrolment_intents/{enrolment_intent_id}

Path parameters

enrolment_intent_idstring required
Example:ei_3b1333d87d9d4fd6ad83ba7f6b0e951a

Headers

X-Platform-Idstring

The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

Request body

desired_policy_start_datestring date nullable

The desired date for the employee's policy to start. This date is not guaranteed to be honored by the insurance provider and may be adjusted based on provider-specific rules and requirements. If unspecified, the policy start date will be determined by the insurance provider.

enrolment_datestring date nullable

The date on which the employee agreed to enrol into the group's policies. This date may be used by some insurance providers to determine the policy start date. If unspecified, the enrolment date will default to the date the enrolment intent is processed.

Example request

{
  "desired_policy_start_date": "2024-12-01",
  "enrolment_date": "2024-12-01"
}

Response

OK

idstring required

Unique identifier for the enrolment intent. Prefixed with ei_.

employee_idstring required

Identifier for the employee associated with this enrolment intent. Prefixed with ee_.

group_idstring required

Identifier for the group associated with this enrolment intent. Prefixed with gr_.

status'processing' | 'scheduled' | 'action_required' | 'coverage_options_required' | 'pending_confirmation' | 'enrolling' | 'enrolled' | 'not_undertaken' | 'ineligible' required
force_confirmationboolean required

If set to true, the system will always force the PendingConfirmation state before enrolling the employee, even if no action is required. This can be useful in scenarios where you want to ensure that the employee explicitly confirms their enrolment, regardless of their eligibility or any other factors. Defaults to false.

objectstring

Object type identifier.