Skip to content
/
Create or Update Batch Me...

Create or Update Batch Members

Request

Create or Update multiple Members at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.

Security
apiKeyAuth and bearerAuth
Path
subscriberIDstringrequired

Subscriber ID

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
Array [
subscriber_IDstring, [ 1 .. 9 ] charactersrequired

References the Subscribers.Subscriber_ID value in the parent table.

member_Seqstring or null, <= 2 characters

Sequential identifier assigned to each Member of this family. In combination with Subscriber_ID, creates a unique identifier.

access_Codestring or null, <= 32 characters

Access code defined by the User.

adult_Childstring or null, <= 1 characters

Designates whether the Member is an adult or child. This may be important in cases where premiums differ between adult and child members.

adult_Dependentbooleanrequired

This flag identifies the Member has been approved to continue coverage past the 'Cutoff Age' defined at the 'Group level'. Note: This field is marked as NOT NULL in the database and therefore required by the API.

adult_Dependent_Endstring or null, (date-time)

End date of the Member's approved 'Adult Dependent Status'. Only claims with a date of service up to this date will be allowed to process through adjudication.

alternate_IDstring or null, <= 32 characters

Allows the User to assign an 'Alternate ID' to the Member.

birth_Datestring or null, (date-time)

Date of birth of the Member.

continue_Coveragebooleanrequired

Allows claims to pay past the disenroll date. Below are some examples: (1) A member terminates coverage but is still inpatient. Checking this box, and designating the end of inpatient stay with the 'Thru Date', will allow the claim(s) to pay during this time. The member will still reflect as inactive. (2) A member is on 'Long Term Disability'. Coverage terminates, but payments still need to be made. Same steps as example (1) above. Note: This field is marked as NOT NULL in the database and therefore required by the API.

continue_Coverage_End_Datestring or null, (date-time)

End date of the 'Continued Coverage' period.

continue_Coverage_Ex_Codestring or null, <= 6 characters

Allows for an Ex Code to be assigned when a claim is processed after the disenroll date but within the 'Continue Coverage' period.

coverage_Typestring or null, <= 32 characters

Indicates the type of coverage ('Open Enrollment', 'Late Enrollment', etc.).

credible_Coverageinteger or null, (int32)

Total number of days for the Credible Coverage period.

creditable_Coverage_Endstring or null, (date-time)

End date of the Member's 'Credible Coverage' period. These dates are used in the stock ‘Creditable Coverage’ COBRA reports.

creditable_Coverage_Startstring or null, (date-time)

Start date of the Member's 'Credible Coverage' period. These dates are used in the stock ‘Creditable Coverage’ COBRA reports.

date_Enrolledstring or null, (date-time)

Original enrollment date of the Member.

date_Of_Deathstring or null, (date-time)

Date of death of the Member.

disenroll_Datestring or null, (date-time)

Disenrollment date of the Member.

entry_Datestring, (date-time)

Date when the record was first added to the system.

entry_Userstring or null, <= 20 characters

User that first added the record to the system.

ethnicity_Codestring or null, <= 1 characters

Ethnicity of the Member.

first_Namestring or null, <= 25 characters

First name of the Member.

heightinteger or null, (int32)

The members height in inches.

initial_Premiumnumber or null, (double)
initial_Volumenumber or null, (double)

This is the volume used in intial volume calculations. This number can either be a flat amount or a percentage of the Member's gross salary.

initial_Volume_Salary_Pctbooleanrequired

Indicates that the number from the 'Initial Volume' field represents a percentage of the Member's salary. Salaries are found from a Member's 'Financial' detail dropdown. Note: This field is marked as NOT NULL in the database and therefore required by the API.

last_Namestring or null, <= 25 characters

Last name of the Member.

marital_Statusstring or null, <= 1 characters

Marital status of the Member.

middle_Namestring or null, <= 25 characters

Middle initial of the Member.

name_Suffixstring or null, <= 16 characters

Suffix or title associated with the Member.

notesstring or null

No longer in use. Replaced by NotData, NoteSource and NoteReference tables.

other_Insurancebooleanrequired

An optional reminder that the Member has an 'Other Insurance'. [Informational Only] Note: This field is marked as NOT NULL in the database and therefore required by the API.

other_Namestring or null, <= 96 characters

Information only used in custom reporting.

pend_Ex_Codestring or null, <= 6 characters

Assigns an Ex Code that can be applied to newly adjudicated Subscriber claims.

pend_Flagstring or null, <= 1 characters

While active, assigned Ex Codes will be applied to any newly adjudicated Subscriber claims.

plan_Year_Frequencyinteger or null, (int32)

Defines the number of months/years covered by the Member's plan.

plan_Year_Frequency_Typestring or null, <= 1 characters

Specifies the timeframe the Member Plan Year will use.

pre_Existstring or null, <= 1 characters

Identifies whether the Member has any pre-existing conditions.

pre_Exist_Endstring or null, (date-time)

End date of pre-existing conditions in relation to the Member's plan.

pre_Exist_Ex_Codestring or null, <= 6 characters

Assigns an Ex Code to pre-existing Claims.

preferred_Pronounstring or null, <= 256 characters
relationshipstring or null, <= 12 characters

Relationship of the Member to the Subscriber.

ssnstring or null, <= 32 characters

Social security number of the Member.

salutationstring or null, <= 16 characters

Information only used in custom reporting.

sexstring or null, <= 1 characters

Biological sex of the Member.

smokerbooleanrequired

Designates whether the Member is a smoker. This may be important in cases where premiums differ between smokers and non-smokers. Note: This field is marked as NOT NULL in the database and therefore required by the API.

studentstring or null, <= 1 characters

Identifies that the Member meets the 'Student Status' requirements.

student_Endstring or null, (date-time)

End date of the Member's approved 'Student Status'. Only claims with a date of service up to this date will be allowed to process through adjudication.

unique_IDstring or null, <= 32 characters

Unique identifier assigned to the Member by the User.

update_Datestring, (date-time)

Date when the record was last updated in the system.

update_Userstring or null, <= 20 characters

User that last updated the record in the system.

use_Member_Plan_Yearbooleanrequired

Identifies the Member's Plan year if it differs from the group. The User is required to define a number of months or years for the Plan. The Member's Plan year will begin on the first day of enrollment. Note: This field is marked as NOT NULL in the database and therefore required by the API.

viP_Flagstring or null, <= 1 characters

VIP status of the Member. This status can be used as a search filter but is otherwise informational only.

weightinteger or null, (int32)

The members weight in pounds.

]
curl -i -X PUT \
  'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/members-batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '[
    {
      "subscriber_ID": "string",
      "member_Seq": "st",
      "access_Code": "string",
      "adult_Child": "s",
      "adult_Dependent": true,
      "adult_Dependent_End": "2019-08-24T14:15:22Z",
      "alternate_ID": "string",
      "birth_Date": "2019-08-24T14:15:22Z",
      "continue_Coverage": true,
      "continue_Coverage_End_Date": "2019-08-24T14:15:22Z",
      "continue_Coverage_Ex_Code": "string",
      "coverage_Type": "string",
      "credible_Coverage": 0,
      "creditable_Coverage_End": "2019-08-24T14:15:22Z",
      "creditable_Coverage_Start": "2019-08-24T14:15:22Z",
      "date_Enrolled": "2019-08-24T14:15:22Z",
      "date_Of_Death": "2019-08-24T14:15:22Z",
      "disenroll_Date": "2019-08-24T14:15:22Z",
      "entry_Date": "2019-08-24T14:15:22Z",
      "entry_User": "string",
      "ethnicity_Code": "s",
      "first_Name": "string",
      "height": 0,
      "initial_Premium": 0.1,
      "initial_Volume": 0.1,
      "initial_Volume_Salary_Pct": true,
      "last_Name": "string",
      "marital_Status": "s",
      "middle_Name": "string",
      "name_Suffix": "string",
      "notes": "string",
      "other_Insurance": true,
      "other_Name": "string",
      "pend_Ex_Code": "string",
      "pend_Flag": "s",
      "plan_Year_Frequency": 0,
      "plan_Year_Frequency_Type": "s",
      "pre_Exist": "s",
      "pre_Exist_End": "2019-08-24T14:15:22Z",
      "pre_Exist_Ex_Code": "string",
      "preferred_Pronoun": "string",
      "relationship": "string",
      "ssn": "string",
      "salutation": "string",
      "sex": "s",
      "smoker": true,
      "student": "s",
      "student_End": "2019-08-24T14:15:22Z",
      "unique_ID": "string",
      "update_Date": "2019-08-24T14:15:22Z",
      "update_User": "string",
      "use_Member_Plan_Year": true,
      "viP_Flag": "s",
      "weight": 0
    }
  ]'

Responses

Success

Bodyapplication/json
dataArray of objects or null
errorobject
debugobject
Response
{
  "data": [ … ],
  "error": { … },
  "debug": { … }
}

Create or Update Batch Members

Request

Create or Update multiple Members at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.

Security
apiKeyAuth and bearerAuth
Path
subscriberIDstringrequired

Subscriber ID

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
Array [
subscriber_IDstring, [ 1 .. 9 ] charactersrequired

References the Subscribers.Subscriber_ID value in the parent table.

member_Seqstring or null, <= 2 characters

Sequential identifier assigned to each Member of this family. In combination with Subscriber_ID, creates a unique identifier.

access_Codestring or null, <= 32 characters

Access code defined by the User.

adult_Childstring or null, <= 1 characters

Designates whether the Member is an adult or child. This may be important in cases where premiums differ between adult and child members.

adult_Dependentbooleanrequired

This flag identifies the Member has been approved to continue coverage past the 'Cutoff Age' defined at the 'Group level'. Note: This field is marked as NOT NULL in the database and therefore required by the API.

adult_Dependent_Endstring or null, (date-time)

End date of the Member's approved 'Adult Dependent Status'. Only claims with a date of service up to this date will be allowed to process through adjudication.

alternate_IDstring or null, <= 32 characters

Allows the User to assign an 'Alternate ID' to the Member.

birth_Datestring or null, (date-time)

Date of birth of the Member.

continue_Coveragebooleanrequired

Allows claims to pay past the disenroll date. Below are some examples: (1) A member terminates coverage but is still inpatient. Checking this box, and designating the end of inpatient stay with the 'Thru Date', will allow the claim(s) to pay during this time. The member will still reflect as inactive. (2) A member is on 'Long Term Disability'. Coverage terminates, but payments still need to be made. Same steps as example (1) above. Note: This field is marked as NOT NULL in the database and therefore required by the API.

continue_Coverage_End_Datestring or null, (date-time)

End date of the 'Continued Coverage' period.

continue_Coverage_Ex_Codestring or null, <= 6 characters

Allows for an Ex Code to be assigned when a claim is processed after the disenroll date but within the 'Continue Coverage' period.

coverage_Typestring or null, <= 32 characters

Indicates the type of coverage ('Open Enrollment', 'Late Enrollment', etc.).

credible_Coverageinteger or null, (int32)

Total number of days for the Credible Coverage period.

creditable_Coverage_Endstring or null, (date-time)

End date of the Member's 'Credible Coverage' period. These dates are used in the stock ‘Creditable Coverage’ COBRA reports.

creditable_Coverage_Startstring or null, (date-time)

Start date of the Member's 'Credible Coverage' period. These dates are used in the stock ‘Creditable Coverage’ COBRA reports.

date_Enrolledstring or null, (date-time)

Original enrollment date of the Member.

date_Of_Deathstring or null, (date-time)

Date of death of the Member.

disenroll_Datestring or null, (date-time)

Disenrollment date of the Member.

entry_Datestring, (date-time)

Date when the record was first added to the system.

entry_Userstring or null, <= 20 characters

User that first added the record to the system.

ethnicity_Codestring or null, <= 1 characters

Ethnicity of the Member.

first_Namestring or null, <= 25 characters

First name of the Member.

heightinteger or null, (int32)

The members height in inches.

initial_Premiumnumber or null, (double)
initial_Volumenumber or null, (double)

This is the volume used in intial volume calculations. This number can either be a flat amount or a percentage of the Member's gross salary.

initial_Volume_Salary_Pctbooleanrequired

Indicates that the number from the 'Initial Volume' field represents a percentage of the Member's salary. Salaries are found from a Member's 'Financial' detail dropdown. Note: This field is marked as NOT NULL in the database and therefore required by the API.

last_Namestring or null, <= 25 characters

Last name of the Member.

marital_Statusstring or null, <= 1 characters

Marital status of the Member.

middle_Namestring or null, <= 25 characters

Middle initial of the Member.

name_Suffixstring or null, <= 16 characters

Suffix or title associated with the Member.

notesstring or null

No longer in use. Replaced by NotData, NoteSource and NoteReference tables.

other_Insurancebooleanrequired

An optional reminder that the Member has an 'Other Insurance'. [Informational Only] Note: This field is marked as NOT NULL in the database and therefore required by the API.

other_Namestring or null, <= 96 characters

Information only used in custom reporting.

pend_Ex_Codestring or null, <= 6 characters

Assigns an Ex Code that can be applied to newly adjudicated Subscriber claims.

pend_Flagstring or null, <= 1 characters

While active, assigned Ex Codes will be applied to any newly adjudicated Subscriber claims.

plan_Year_Frequencyinteger or null, (int32)

Defines the number of months/years covered by the Member's plan.

plan_Year_Frequency_Typestring or null, <= 1 characters

Specifies the timeframe the Member Plan Year will use.

pre_Existstring or null, <= 1 characters

Identifies whether the Member has any pre-existing conditions.

pre_Exist_Endstring or null, (date-time)

End date of pre-existing conditions in relation to the Member's plan.

pre_Exist_Ex_Codestring or null, <= 6 characters

Assigns an Ex Code to pre-existing Claims.

preferred_Pronounstring or null, <= 256 characters
relationshipstring or null, <= 12 characters

Relationship of the Member to the Subscriber.

ssnstring or null, <= 32 characters

Social security number of the Member.

salutationstring or null, <= 16 characters

Information only used in custom reporting.

sexstring or null, <= 1 characters

Biological sex of the Member.

smokerbooleanrequired

Designates whether the Member is a smoker. This may be important in cases where premiums differ between smokers and non-smokers. Note: This field is marked as NOT NULL in the database and therefore required by the API.

studentstring or null, <= 1 characters

Identifies that the Member meets the 'Student Status' requirements.

student_Endstring or null, (date-time)

End date of the Member's approved 'Student Status'. Only claims with a date of service up to this date will be allowed to process through adjudication.

unique_IDstring or null, <= 32 characters

Unique identifier assigned to the Member by the User.

update_Datestring, (date-time)

Date when the record was last updated in the system.

update_Userstring or null, <= 20 characters

User that last updated the record in the system.

use_Member_Plan_Yearbooleanrequired

Identifies the Member's Plan year if it differs from the group. The User is required to define a number of months or years for the Plan. The Member's Plan year will begin on the first day of enrollment. Note: This field is marked as NOT NULL in the database and therefore required by the API.

viP_Flagstring or null, <= 1 characters

VIP status of the Member. This status can be used as a search filter but is otherwise informational only.

weightinteger or null, (int32)

The members weight in pounds.

]
curl -i -X PUT \
  'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/members-batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '[
    {
      "subscriber_ID": "string",
      "member_Seq": "st",
      "access_Code": "string",
      "adult_Child": "s",
      "adult_Dependent": true,
      "adult_Dependent_End": "2019-08-24T14:15:22Z",
      "alternate_ID": "string",
      "birth_Date": "2019-08-24T14:15:22Z",
      "continue_Coverage": true,
      "continue_Coverage_End_Date": "2019-08-24T14:15:22Z",
      "continue_Coverage_Ex_Code": "string",
      "coverage_Type": "string",
      "credible_Coverage": 0,
      "creditable_Coverage_End": "2019-08-24T14:15:22Z",
      "creditable_Coverage_Start": "2019-08-24T14:15:22Z",
      "date_Enrolled": "2019-08-24T14:15:22Z",
      "date_Of_Death": "2019-08-24T14:15:22Z",
      "disenroll_Date": "2019-08-24T14:15:22Z",
      "entry_Date": "2019-08-24T14:15:22Z",
      "entry_User": "string",
      "ethnicity_Code": "s",
      "first_Name": "string",
      "height": 0,
      "initial_Premium": 0.1,
      "initial_Volume": 0.1,
      "initial_Volume_Salary_Pct": true,
      "last_Name": "string",
      "marital_Status": "s",
      "middle_Name": "string",
      "name_Suffix": "string",
      "notes": "string",
      "other_Insurance": true,
      "other_Name": "string",
      "pend_Ex_Code": "string",
      "pend_Flag": "s",
      "plan_Year_Frequency": 0,
      "plan_Year_Frequency_Type": "s",
      "pre_Exist": "s",
      "pre_Exist_End": "2019-08-24T14:15:22Z",
      "pre_Exist_Ex_Code": "string",
      "preferred_Pronoun": "string",
      "relationship": "string",
      "ssn": "string",
      "salutation": "string",
      "sex": "s",
      "smoker": true,
      "student": "s",
      "student_End": "2019-08-24T14:15:22Z",
      "unique_ID": "string",
      "update_Date": "2019-08-24T14:15:22Z",
      "update_User": "string",
      "use_Member_Plan_Year": true,
      "viP_Flag": "s",
      "weight": 0
    }
  ]'

Responses

Success

Bodyapplication/json
dataArray of objects or null
errorobject
debugobject
Response
{
  "data": [ … ],
  "error": { … },
  "debug": { … }
}