ConnectApi.MemberWithPlansInputRepresentation

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

PropertyTypeDescriptionRequired or OptionalAvailable Version
accountIdStringID of the person account record of the member.Optional68.0
addedPlansList<ConnectApi.MemberPlanInputRepresentation>Insurance plans to add to an existing member.Required to add members.68.0
additionalFieldsMap<String, Object>Values for custom fields on the GroupCensusMember record, keyed by field API name.Optional68.0
annualEligibleSalaryDoubleAnnual salary of the member that’s eligible for benefits calculations.Optional68.0
associationWithPrimaryMbrStringFor a dependent, the association to the primary member, such as Spouse or Child.Optional68.0
birthdateStringDate of birth of the member, in YYYY-MM-DD format.Optional68.0
cityStringCity in the member’s address.Optional68.0
contactIdStringID of the contact record of the member.Optional68.0
countryStringCountry in the member’s address.Optional68.0
deletedPlansList<String>IDs of the GroupCensusMemberPlan records to remove for this member.Optional. Use this property only when you update a member.68.0
dependentCountIntegerNumber of dependents that are associated with the member.Optional68.0
emailStringEmail address of the member.Optional68.0
firstNameStringFirst name of the member.Optional68.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 GroupCensus record that the member belongs to.Optional68.0
groupCensusMemberPlansList<ConnectApi.MemberPlanInputRepresentation>Insurance plans to associate with the member.Optional. Use this property only when you add a member.68.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 GroupCensusGroupClassSummary record.Optional68.0
idStringID of the GroupCensusMember record to update along with its associated insurance plans.Required when you update a member. Don’t specify this ID when you add a member.68.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 is created for this member (true) or not (false).Optional68.0
joinDateStringDate that the member joined the group or company.Optional68.0
lastnameStringLast name of the member.Optional68.0
memberKeyStringExternally defined key that uniquely identifies the member and prevents duplicates. This key is often a concatenation of several field values.Optional68.0
memberTypeStringType of member, such as Primary or Dependent.Optional68.0
nameStringFull name of the member. This value is saved to the Name field of the GroupCensusMember record.Required68.0
optOutPlanTypesStringTypes of plans that the member has opted out of.Optional68.0
overrideTypeConfigurationStringConfiguration that governs which plan overrides are permitted for the member, such as Default, Override Attributes, or Override Plans and Attributes.Optional68.0
phoneNumberStringPhone number of the member.Optional68.0
policyStartDateStringDate that the member’s policy coverage begins.Optional68.0
postalCodeStringPostal code or ZIP code in the member’s address.Optional68.0
primaryGroupCensusMemberIdStringID of the primary GroupCensusMember record that the dependents are associated with.Optional68.0
primaryMemberCategoryStringCategory of the primary member.Optional68.0
primaryMemberSourceStringSystem or source that the member’s data originated from.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 of the member in an external source system. Use this ID for integration purposes.Optional68.0
stateStringState or province in the member’s address.Optional68.0
statusStringCurrent status of the member, such as Active or Inactive.Optional68.0
streetStringStreet in the member’s address.Optional68.0
upsertedPlansList<ConnectApi.MemberPlanInputRepresentation>Insurance plans to add or update for an existing member.Optional. Use this property only when you update a member.68.0