Insurance Developer Guide

Get Started with Insurance Developer Resources
Insurance Brokerage
Insurance Claims Management
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
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
PDF

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
Name Type Description Required or Optional Available Version
accountId String Person account ID of the member. Optional 68.0
addedPlans Member Plan Input[] List of plans to assign to the member. Optional 68.0
additionalFields Object Additional custom (non-standard) fields to add to the group census member, specified by field API name. Optional 68.0
annualEligibleSalary Double Annual salary of the member that's eligible for benefits calculations. Optional 68.0
associationWithPrimaryMbr String Association to the primary member for dependents, such as Spouse or Child. Optional 68.0
birthdate String Date of birth of the member, in YYYY-MM-DD format. Optional 68.0
city String City of the member's address. Optional 68.0
contactId String ID of the contact record of the member. Optional 68.0
country String Country of the member's address. Optional 68.0
deletedPlans String[] List of insurance plan IDs to remove for this member. Optional 68.0
dependentCount Integer Number of dependents that are associated with the member. Optional 68.0
email String Email address of the member. Optional 68.0
firstName String First name of the member. Required to add member 68.0
fullTimeEquivalent Double Work capacity of the member, where 1.0 indicates a full-time employee. Optional 68.0
gender String Gender of the member. Optional 68.0
groupCensusId String ID of the group census that the member belongs to. Optional 68.0
groupCensusMemberPlans Member Plan Input[] List of insurance plans associated with this member. Optional 68.0
groupClassId String ID of the class or category within the group that the member belongs to. Optional 68.0
groupClassName String Name of the group class. Optional 68.0
grpCensusGrpClassSummaryId String ID of the related group census group class summary record. Optional 68.0
id String ID of the group census member whose details and associated insurance plans you want to add or update. Required to update member 68.0
isOptOutAllPlans Boolean Indicates whether the member has opted out of all available insurance plans (true) or not (false). Optional 68.0
isPortalUser Boolean Indicates whether a community portal user must be created for this member (true) or not (false). Optional 68.0
joinDate String Date the member joined the group or company. Optional 68.0
lastname String Last name of the member. Required to add member 68.0
memberKey String Unique, externally defined key that's used to identify and prevent duplicate members, often created by concatenating several fields. Optional 68.0
memberType String Type of member, such as Primary or Dependent. Optional 68.0
name String Full name of the member. Optional 68.0
optOutPlanTypes String Types of plans the member has opted out of. Optional 68.0
overrideTypeConfiguration String Override configuration for the member that governs which plan overrides are permitted, such as Default, Override Attributes, or Override Plans and Attributes. Optional 68.0
phoneNumber String Phone number of the member. Optional 68.0
policyStartDate String Date when the member's policy coverage begins. Optional 68.0
postalCode String Postal or ZIP code of the member's address. Optional 68.0
primaryGroupCensusMemberId String ID of the primary group census member that the dependents are associated with. Optional 68.0
primaryMemberCategory String Category of the primary member. Optional 68.0
primaryMemberSource String System or source from which the member's data originated. Optional 68.0
relationshipToPrimaryMember String Member's relationship to the primary insured. Optional 68.0
smokerStatus String Smoking status of the member, such as Smoker or Non-smoker. Optional 68.0
sourceSystemIdentifier String ID from an external source system, used for integration. Optional 68.0
state String State or province the member belongs to. Optional 68.0
status String Current status of the member, such as Active or Inactive. Optional 68.0
street String Street address of the member. Optional 68.0
upsertedPlans Member Plan Input[] List of existing insurance plans to add or update for this member. Required for PATCH operation 68.0