Input representation of the census details, member identifiers, optional policy date,
and additional fields used to generate or update group census members from policy information on a
contract.
| Property | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| additionalFields | ConnectApi.InsuranceGenerateRefreshCensusMembers​AdditionalFieldsRep | Additional field values to apply to each group census member during the upsert operation. Use this parameter to set nonstandard fields, such as extended or custom fields. | Optional | 68.0 |
| censusName | String | Name for the group census record. | Optional | 68.0 |
| censusType | String | Type of census, for example Enrollment or Quote. | Optional | 68.0 |
| contactIds | List<String> | Contact IDs used to extract member information. If you specify contact IDs, you must also specify a policy ID to correctly identify the associated members. | Optional | 68.0 |
| groupCensusId | String | ID of the group census. Required when you update existing group census member details. | Required when you update existing group census member details. | 68.0 |
| personAccountIds | List<String> | IDs of the Person Accounts used to identify the members to include when processing the group census. Member information is extracted from the specified accounts. | Optional | 68.0 |
| policyEffectiveDate | String | Date used to determine the policy version for generating or updating group census member details, in ISO 8601 yyyy-MM-dd format. The specified date must fall between the policy version's effectiveFromDate and effectiveToDate. | Optional | 68.0 |
| policyIds | List<String> | Policy IDs from which member information is retrieved for the specified contacts or accounts. | Optional | 68.0 |
| shouldGenerateCsv | Boolean | Indicates whether to create a CSV file with all the census data (true) or not (false). | Optional | 68.0 |
| shouldIncludeMemberPlans | Boolean | Indicates whether to include plan details for the members in the processed group census (true) or not (false). If set to true, the group census includes insurance plan details for each member. | Optional | 68.0 |