Skip to content

Create Tier

Request

Creates a new Tier

Security
apiKeyAuth and bearerAuth
Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
tier1string, [ 1 .. 2 ] charactersrequired

Identifier for the specific tier

dependentbooleanrequired

Flag indicating the tier includes any dependents

descriptionstring or null, <= 20 characters

Description of the specific tier

hipaA_Codestring or null, <= 8 characters

Code used by HIPAA to identify the specific tier

insuredbooleanrequired

Flag indicating the tier includes the insured

max_Membersinteger or null, (int32)

Maximum total members the tier allows.

multimember_Tierbooleanrequired

Flag indicating the tier allows multiple members

spousebooleanrequired

Flag indicating the tier includes the spouse

spouse_Onlystring or null, <= 1 characters

Flag indicating the tier includes only the spouse

curl -i -X POST \
  https://vbapi.vbasoftware.com/vbasoftware/tiers \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "tier1": "st",
    "dependent": true,
    "description": "string",
    "hipaA_Code": "string",
    "insured": true,
    "max_Members": 0,
    "multimember_Tier": true,
    "spouse": true,
    "spouse_Only": "s"
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}