Skip to content
/
Update MemberCOBSavings

Update MemberCOBSavings

Request

Updates a specific MemberCOBSavings.

Security
apiKeyAuth and bearerAuth
Path
subscriberIDstringrequired

Subscriber ID

memberSeqstringrequired

Member Seq

memberCOBSavingsKeyinteger, (int32)required

MemberCOBSavings Key

Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
memberCOBSavings_Keyinteger, (int32)required

Unique identifier for each COB Savings record for this Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.

coB_Savingsnumber or null, (double)

Allows the User to override the automated COB Savings amount. If the ‘Use COB Savings’ option is selected within ‘Plan Options’, COB Savings auto-populate based upon the ‘COB’ amount.

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

Group associated with the COB savings override.

member_Seqstring, [ 1 .. 2 ] charactersrequired

References Members.Member_Seq value on the parent record.

plan_Typestring, [ 1 .. 6 ] charactersrequired

Identifies the plan type that the COB savings override will be applied to.

plan_Yearstring, [ 1 .. 8 ] charactersrequired

Identifies the plan year that the COB savings override will be applied to.

subscriber_IDstring, [ 1 .. 9 ] charactersrequired

References Members.Subscriber_ID value on the parent record.

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.

curl -i -X PUT \
  'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/members/{memberSeq}/cob-savings/{memberCOBSavingsKey}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "memberCOBSavings_Key": 0,
    "coB_Savings": 0.1,
    "entry_Date": "2019-08-24T14:15:22Z",
    "entry_User": "string",
    "group_ID": "string",
    "member_Seq": "st",
    "plan_Type": "string",
    "plan_Year": "string",
    "subscriber_ID": "string",
    "update_Date": "2019-08-24T14:15:22Z",
    "update_User": "string"
  }'

Responses

Success

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