# Member Disenroll

Disenrolls a Member from an Enrollment.  A VBAProcess object is returned representing the process state. See VBAProcess area for more information.

Endpoint: POST /subscribers/{subscriberID}/members/{memberSeq}/disenroll
Version: v1
Security: apiKeyAuth, bearerAuth

## Header parameters:

  - `vbasoftware-database` (string, required)
    Target database

## Path parameters:

  - `subscriberID` (string, required)
    Subscriber ID

  - `memberSeq` (string, required)
    Member Seq

## Request fields (application/json):

  - `user_ID` (string, required)
    The user for which this request is executed on behalf of.

  - `subscriber_ID` (string, required)
    The Subscirber ID of the Member being disenrolled.  You can get the Subscriber ID via the SearchConfig process using ENROLLMENT searchConfigId (https://vbapi-docs.vbasoftware.com/developer-portal/search/).

  - `member_Seq` (string, required)
    The Member Sequence of the Member being disenrolled.  If this is a Subscriber Disenroll, the Member Sequence provided is the Insured Member Sequence.  You can get the Member Seq via the SearchConfig process using ENROLLMENT searchConfigId (https://vbapi-docs.vbasoftware.com/developer-portal/search/).

  - `group_ID` (string, required)
    The Group ID of the current Subenrollment record (the members current or most recent enrollment).  You can use the List SubEnrollment API (https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments) to get the values you need.

  - `division_ID` (string, required)
    The Division ID of the current Subenrollment record (the members current or most recent enrollment).  You can use the List SubEnrollment API (https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments) to get the values you need.

  - `group_Coverage_Start` (string, required)
    The Group Coverage Start of the current Subenrollment record (the members current or most recent enrollment).  You can use the List SubEnrollment API (https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments) to get the values you need.  This is only required on Subscriber/Member Disenrolls, for Group/Division Disenroll, this can be blank.

  - `start_Date` (string, required)
    The Start Date of the current Subenrollment record (the members current or most recent enrollment).  You can use the List SubEnrollment API (https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments) to get the values you need.  This is only required on Subscriber/Member Disenrolls, for Group/Division Disenroll, this can be blank.

  - `disenroll_Date` (string, required)
    The Disenroll Date for this disenroll process.

  - `term_Date` (string,null)
    Term Date is an informational field used in some reports.  It doesn't impact the process but is often populated with the same value as the Disenroll Date.

  - `subscriber` (boolean, required)
    The Subscriber value is a flag indicating if the member being disenrolled is the Insured.  Send 1 if this is the Subscriber, send 0 if this is a Spouse/Dependent/Other.  This is only required on Subscriber/Member Disenrolls, for Group/Division Disenroll, this can be blank.

  - `reason_ID` (integer, required)
    Reason ID is the reson for this disenroll.  You can get a list of valid Reason IDs from the List Reasons API (https://vbapi.vbasoftware.com/vbasoftware/reasons).

  - `premium` (number,null)
    When not using the PremRates list of PremRate_Key values, this indicates the COBRA Premium for some reports.

  - `disenrollFamily` (integer, required)
    The DisenrollFamily indicator lets the Disenroll process know exactly how to perform the Disenroll.  You can get a list of valid DisenrollFamily values from the List Disenrollment Family Options API (https://vbapi.vbasoftware.com/vbasoftware/disenroll-family-options).

  - `terminateAuth` (boolean, required)
    The TerminateAuth flag lets us know if Auths approved or requested beyond the Disenroll Date should be cancelled.

  - `disenrollFuture` (integer, required)
    The DisenrollFuture indicator will tell us how to handle any future enrollments beyond the Disenroll Date related to this disenroll.  The valid values are:
2 - Disenroll Future Enrollments
3 - Do Not Disenroll any Future Enrollments

  - `premRates` (array,null)
    The list of COBRA Rates associated with this Disenroll process.

  - `premInvoiceAdjustments` (array,null)
    If you intend to auto-adjust existing premiums based on this disenroll you would populate your adjustments here.

  - `premInvoiceAdjustments.invoiceAdjustment_Key` (integer, required)
    Unique identifier for the adjustment Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `premInvoiceAdjustments.adjustment_Amount` (number,null)
    Amount of the adjustment

  - `premInvoiceAdjustments.adjustment_Comment` (string,null)
    Comments made for this adjustment

  - `premInvoiceAdjustments.adjustment_PremRate_Key` (integer,null)
    Key of the rate the adjustment is for

  - `premInvoiceAdjustments.adjustment_Reason` (integer,null)
    Reason for this adjustment. References record in InvoiceReason.

  - `premInvoiceAdjustments.adjustment_Received` (number,null)
    Received amounts for this adjustment

  - `premInvoiceAdjustments.auto_Adjust` (boolean, required)
    Flag used to identify this adjustment as an automatically created adjustment Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `premInvoiceAdjustments.avoid_Retro` (boolean, required)
    Flag used to prevent the retro logic from creating backout adjustments for this adjustment Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `premInvoiceAdjustments.division_ID` (string,null)
    Unique identifier for the Division

  - `premInvoiceAdjustments.effective_Date` (string,null)
    Effective Date of the adjustment

  - `premInvoiceAdjustments.entry_Date` (string)
    Date record was first added to the system

  - `premInvoiceAdjustments.entry_User` (string,null)
    User that first added the record to the system

  - `premInvoiceAdjustments.group_ID` (string,null)
    Unique identifier for the Group

  - `premInvoiceAdjustments.invoice_Key` (integer,null)
    Key to the invoice the adjustment is for

  - `premInvoiceAdjustments.min_Max_Adjust` (boolean, required)
    Flag used to identify this adjustment was created from exceeding a minimum or maximum amount Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `premInvoiceAdjustments.negative_Adjustment` (boolean, required)
    Flag used to determine when the amount is negative Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `premInvoiceAdjustments.premRate_Key` (integer,null)
    Key of the original rate the adjustment is for

  - `premInvoiceAdjustments.retro_Adjustment_Invoice_Key` (integer,null)
    Original invoice key for retro adjustments

  - `premInvoiceAdjustments.selfAdmin_Adj` (boolean, required)
    Flag used to identify this adjustment as Self-Admin Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `premInvoiceAdjustments.subscriber_ID` (string,null)
    Unique identifier for the Subscriber

  - `premInvoiceAdjustments.update_Date` (string)
    Date the record was last updated in the system

  - `premInvoiceAdjustments.update_User` (string,null)
    User that last updated the record in the system

  - `premInvoiceAdjustments.use_Premium` (boolean, required)
    Flag used to determine when the premium is used to calculate the adjustment Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `premInvoiceAdjustments.volume` (number,null)
    Volume for this adjustment

## Response 200 fields (text/plain):

  - `data` (object)

  - `data.vbaProcess_Key` (integer, required)
    Unique Identifier for the VBAProcess table Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.vbaProcess_Type` (string, required)
    Type used to determine the process that triggers.

  - `data.description` (string,null)
    Description of the process.

  - `data.entry_Date` (string)
    Date record was first added to the system

  - `data.entry_User` (string,null)
    User that first added the record to the system

  - `data.process_End` (string,null)
    Date and time the process ended.

  - `data.process_Result` (string,null)
    Result of the process.

  - `data.process_Start` (string,null)
    Date and time the process started.

  - `data.process_User` (string,null)
    User that started the process.

  - `data.update_Date` (string)
    Date the record was last updated in the system

  - `data.update_User` (string,null)
    User that last updated the record in the system

  - `error` (object)

  - `error.detail` (string,null)
    A human-readable explanation specific to this occurrence of the problem.

  - `error.instance` (string,null)
    A URI reference that identifies the specific occurrence of the problem.It may
or may not yield further information if dereferenced.

  - `error.status` (integer)
    The HTTP status code([RFC7231], Section 6) generated by the origin server for
this occurrence of the problem.

  - `error.title` (string,null)
    A short, human-readable summary of the problem type.It SHOULD NOT change from
occurrence to occurrence of the problem, except for purposes of localization(e.g.,
using proactive content negotiation; see[RFC7231], Section 3.4).

  - `error.type` (string,null)
    A URI reference [RFC3986] that identifies the problem type. This specification
encourages that, when dereferenced, it provide human-readable documentation for
the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member
is not present, its value is assumed to be "about:blank".

  - `debug` (object)

  - `debug.activityID` (string, required)


## Response 401 fields