API ReferenceMembers

Create an approved member qualifying life event

Creates an immediately approved qualifying life event. The caller must have write access to the target member, and API access tokens cannot create events. A member not visible to the caller returns a 404 before the body is validated. Describing the event is required when event_type is ‘other’.

Authentication

AuthorizationBearer

API Key or Access Token authentication using Bearer token in Authorization header. API keys use the vit_apk_ prefix, access tokens use the vit_at_ prefix.

Path parameters

member_idstringRequired

Unique member identifier (mbr_*)

Headers

X-Vitable-OrganizationstringOptional
Organization to act as for this request (e.g. `org_SGVsbG8gV29ybGQ`). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 `organization_required`. A malformed value returns 400 `invalid_organization_header`, and naming an organization you do not have access to returns 403 `organization_access_denied`.

Request

This endpoint expects an object.
event_typeenumRequired

The qualifying life event reason. new_child is a historical value and is not accepted when creating a new event.

  • lost_job_based_coverage - lost_job_based_coverage
  • aged_off_parent_plan - aged_off_parent_plan
  • lost_medicaid_chip_medicare - lost_medicaid_chip_medicare
  • lost_decertified_individual_plan - lost_decertified_individual_plan
  • married - married
  • divorced - divorced
  • had_baby - had_baby
  • adopted_child - adopted_child
  • foster_care_placement - foster_care_placement
  • death_of_spouse_or_dependent - death_of_spouse_or_dependent
  • court_ordered - court_ordered
  • moved_to_new_coverage_area - moved_to_new_coverage_area
  • moved_to_us - moved_to_us
  • moved_to_or_from_school_housing - moved_to_or_from_school_housing
  • moved_to_or_from_seasonal_work_housing - moved_to_or_from_seasonal_work_housing
  • became_us_citizen - became_us_citizen
  • left_incarceration - left_incarceration
  • gained_tribal_status - gained_tribal_status
  • started_or_ended_americorps_service - started_or_ended_americorps_service
  • new_child - new_child
  • other - other
other_eventstring or nullOptional<=128 characters

Free-text description of the event; required when event_type is ‘other’

Response headers

X-RateLimit-Limitinteger
Maximum number of requests allowed within the rate limit window
X-RateLimit-Remaininginteger
Number of requests remaining in the current rate limit window
X-RateLimit-Resetinteger

Unix timestamp (seconds) when the rate limit window resets

Response

dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error