Skip to content

Create GroupVBAPlanTypeSubscriberID

Request

Creates a new GroupVBAPlanTypeSubscriberID

Security
apiKeyAuth and bearerAuth
Path
groupIDstringrequired

Group ID

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
groupVBAPlanTypeSubscriberID_Keyinteger, (int32)required

Unique identifier for each Plan Type Sub ID configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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.

group_IDstring, [ 1 .. 20 ] charactersrequired

References the Groups.Group_ID value on the parent record.

iD_Prefixstring or null, <= 8 characters

The prefix to be applied to custom VBA Plan Type IDs.

iD_Suffixstring or null, <= 8 characters

The suffix to be applied to custom VBA Plan Type IDs.

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.

vbA_Plan_Typestring or null, <= 32 characters

The VBA Plan Type (Medical, Dental, Vision) to have this ID Prefix/Suffiix applied when generating custom IDs.

curl -i -X POST \
  'https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/vba-plan-types' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "groupVBAPlanTypeSubscriberID_Key": 0,
    "entry_Date": "2019-08-24T14:15:22Z",
    "entry_User": "string",
    "group_ID": "string",
    "iD_Prefix": "string",
    "iD_Suffix": "string",
    "update_Date": "2019-08-24T14:15:22Z",
    "update_User": "string",
    "vbA_Plan_Type": "string"
  }'

Responses

Success

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