Member With Plans Input

Input representation of a group census member and the insurance plans to add or update for that member.

JSON Example 

 
1{
2  "accountId": "001xx000003DGbqAAG",
3  "firstName": "Alex",
4  "lastname": "Taylor",
5  "name": "Alex Taylor",
6  "email": "alex.taylor@example.com",
7  "memberType": "Primary",
8  "associationWithPrimaryMbr": "Self",
9  "relationshipToPrimaryMember": "Self",
10  "birthdate": "1990-08-25",
11  "groupClassName": "Full-Time Salaried",
12  "sourceSystemIdentifier": "WD-EMP-67890",
13  "status": "Active",
14  "addedPlans": [
15    {
16      "contractGroupPlanId": "0gpxx0000000001AAA",
17      "name": "Gold Tier Medical Plan"
18    }
19  ],
20  "upsertedPlans": [],
21  "deletedPlans": []
22}

Properties 
NameTypeDescriptionRequired or OptionalAvailable Version
accountIdStringPerson account ID of the member.Optional68.0
addedPlansMember Plan Input[]List of plans to assign to the member.Optional68.0
additionalFieldsObjectAdditional custom (non-standard) fields to add to the group census member, specified by field API name.Optional68.0
annualEligibleSalaryDoubleAnnual salary of the member that’s eligible for benefits calculations.Optional68.0
associationWithPrimaryMbrStringAssociation to the primary member for dependents, such as Spouse or Child.Optional68.0
birthdateStringDate of birth of the member, in YYYY-MM-DD format.Optional68.0
cityStringCity of the member’s address.Optional68.0
contactIdStringID of the contact record of the member.Optional68.0
countryStringCountry of the member’s address.Optional68.0
deletedPlansString[]List of insurance plan IDs to remove for this member.Optional68.0
dependentCountIntegerNumber of dependents that are associated with the member.Optional68.0
emailStringEmail address of the member.Optional68.0
firstNameStringFirst name of the member.Required to add member68.0
fullTimeEquivalentDoubleWork capacity of the member, where 1.0 indicates a full-time employee.Optional68.0
genderStringGender of the member.Optional68.0
groupCensusIdStringID of the group census that the member belongs to.Optional68.0
groupCensusMemberPlansMember Plan Input[]List of insurance plans associated with this member.Optional68.0
groupClassIdStringID of the class or category within the group that the member belongs to.Optional68.0
groupClassNameStringName of the group class.Optional68.0
grpCensusGrpClassSummaryIdStringID of the related group census group class summary record.Optional68.0
idStringID of the group census member whose details and associated insurance plans you want to add or update.Required to update member68.0
isOptOutAllPlansBooleanIndicates whether the member has opted out of all available insurance plans (true) or not (false).Optional68.0
isPortalUserBooleanIndicates whether a community portal user must be created for this member (true) or not (false).Optional68.0
joinDateStringDate the member joined the group or company.Optional68.0
lastnameStringLast name of the member.Required to add member68.0
memberKeyStringUnique, externally defined key that’s used to identify and prevent duplicate members, often created by concatenating several fields.Optional68.0
memberTypeStringType of member, such as Primary or Dependent.Optional68.0
nameStringFull name of the member.Optional68.0
optOutPlanTypesStringTypes of plans the member has opted out of.Optional68.0
overrideTypeConfigurationStringOverride configuration for the member that governs which plan overrides are permitted, such as Default, Override Attributes, or Override Plans and Attributes.Optional68.0
phoneNumberStringPhone number of the member.Optional68.0
policyStartDateStringDate when the member’s policy coverage begins.Optional68.0
postalCodeStringPostal or ZIP code of the member’s address.Optional68.0
primaryGroupCensusMemberIdStringID of the primary group census member that the dependents are associated with.Optional68.0
primaryMemberCategoryStringCategory of the primary member.Optional68.0
primaryMemberSourceStringSystem or source from which the member’s data originated.Optional68.0
relationshipToPrimaryMemberStringMember’s relationship to the primary insured.Optional68.0
smokerStatusStringSmoking status of the member, such as Smoker or Non-smoker.Optional68.0
sourceSystemIdentifierStringID from an external source system, used for integration.Optional68.0
stateStringState or province the member belongs to.Optional68.0
statusStringCurrent status of the member, such as Active or Inactive.Optional68.0
streetStringStreet address of the member.Optional68.0
upsertedPlansMember Plan Input[]List of existing insurance plans to add or update for this member.Required for PATCH operation68.0

Get Started with Insurance Developer Resources
Insurance Brokerage
Insurance Claims Management
Insurance Design Advisor
Insurance Group Benefits
Insurance Group Benefits Business APIs
Resources
Requests
Insurance Person Accounts and Users Creation Input
Portal User Creation Input
Insurance Member Rating Input
Insurance Member Rating Details Input
Insurance Member Rating Plans Input
Insurance Contacts and Users Creation Input
Bulk Group Census Management Input
Insurance Group Census Member Management Input
Group Census Member Input
Additional Fields Map Value
Insurance Update Member Plans Input
Insurance Add Member Plans Input
Group Census Member Plan Input
Group Census Deep Clone Input
Group Census Field Mapping Input
Group Census Filters Input
Group Census Reference Mappings Input
Member Plan Filter Input
Member Plan Reference Mapping Input
Members With Plans Input
Member With Plans Input
Member Plan Input
Attribute Input
Member Overrides Input
Member Override Input
Override Attribute Input
Insurance Group Endorsement Input
Insurance Group Adjustment Input
Insurance Group Renewal Input
Insurance Price Comparison Input
Delete Member Plans Input
Insurance Plans Eligibility Create Context Input
Insurance Plans Eligibility Update Context Input
Insurance Group Plan Input
Contract Creation Input
Contract Item
Apex String
Insurance Create Quote From Contract Input
Insurance Generate Census Input
Update Group Census Input
Insurance Generate Refresh Census Members Input
Insurance Generate Refresh Census Members Additional Fields Input
Insurance Upsert Member Input
Insurance Census Filter Input
Insurance Quote Configuration Options Input
Insurance Quote Item Input
Insurance Issue Contract Input
Insurance Contract Item Input
Insurance Contract Endorse Input
Insurance Contract Renewal Input
Insurance Contract Transactions Generation Input
Group Rating Input
Individual Enrollment Input
Individual Mid-Term Adjustment Input
Group Enrollment Input
Insurance Delete Census Member Input
Responses
Insurance Group Benefits Apex Reference
Insurance Group Benefits Standard Invocable Actions
Insurance Group Benefits Metadata API Types
Insurance Policy Administration
Insurance Product Administration
Insurance Quoting
Insurance Apex Reference
Error Codes and Responses
Previous PDF Versions