Skip to main content
POST
/
v1
/
external-qualifying-life-events
/
submission
Submit a qualifying life event
curl --request POST \
  --url https://api.vitablehealth.com/v1/external-qualifying-life-events/submission \
  --header 'Content-Type: application/json' \
  --header 'X-Partner-API-Key: <api-key>' \
  --data '
{
  "event": "Married",
  "other_event": "<string>"
}
'
{
  "qle": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "submitted_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "submitted_by_full_name": "<string>",
    "event": "Married",
    "pending_in": true,
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "other_event": "<string>",
    "rejected_on": "2023-11-07T05:31:56Z",
    "accepted_on": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
X-Partner-API-Key
string
header
required

Partner API key for external integrations

Body

application/json

Request to submit a qualifying life event

​
event
enum<string>
required

Types of qualifying life events:

  • Married - Marriage
  • Divorced - Divorce or legal separation
  • New child - Birth or adoption of a child
  • Court ordered - Court-ordered coverage changes
  • Other - Other qualifying life event (requires description)
Available options:
Married,
Divorced,
New child,
Court ordered,
Other
​
other_event
string | null

Description of other qualifying life event if event type is "Other"

Maximum string length: 128

Response

201 - application/json

Qualifying life event submitted successfully

Response from submitting a qualifying life event

​
qle
object
required

A qualifying life event that enables special enrollment periods