Enrollments

Terminate an enrollment

Terminates enrolled coverage immediately. An accepted qualifying life event owned by the enrollment member is required unless the plan is VPC or ICHRA. User-backed callers must provide a reason; it is optional for organization API-key callers. API keys may act across the caller organization's book. Tenant mismatches return the same non-disclosing 404 before the request body is validated.

post/v1/enrollments/{enrollment_id}/terminate

Request

  • Base URL: https://api.vitablehealth.com
  • URL: https://api.vitablehealth.com/v1/enrollments/{enrollment_id}/terminate
  • Auth: HTTP bearer

Path parameters

enrollment_idstring required

Unique enrollment identifier (enrl_*)

Headers

X-Vitable-Organizationstring

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 body

reasonstring nullable

Audit reason for the termination; required for user-backed callers and optional for long-lived organization API-key callers

ticket_numberstring nullable

Optional support or operational ticket number

qualifying_life_event_idstring nullable

Accepted member qualifying life event identifier (qle_*)

Response

No response body

object required

Changes

No recorded changes to this operation across all 1 revision of this API.