Insurance Generate Refresh Census Members Input

Input representation of the details to generate or update group census members from policy information on an existing group benefits contract.

JSON Example 

1{
2  "censusName": "Acme Enrollment Census 2026",
3  "censusType": "Enrollment",
4  "groupCensusId": "0rfxx0000004C92AAA",
5  "policyEffectiveDate": "2026-01-01",
6  "shouldGenerateCsv": true,
7  "shouldIncludeMemberPlans": true,
8  "personAccountIds": [
9    "001xx000003DGb2AAG"
10  ],
11  "contactIds": [
12    "003xx000004WhKhAAK"
13  ],
14  "policyIds": [
15    "0YTxx0000004C92GAE"
16  ],
17  "additionalFields": {
18    "members": [
19      {
20        "memberId": "0YLxx0000004C92EAG",
21        "fields": [
22          {
23            "key": "Status__c",
24            "value": "Active"
25          }
26        ]
27      }
28    ]
29  }
30}

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
additionalFieldsInsurance Generate Refresh Census Members Additional Fields InputAdditional 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.Optional68.0
censusNameStringName for the group census record.Optional68.0
censusTypeStringType of census, for example Enrollment or Quote.Optional68.0
contactIdsString[]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.Optional68.0
groupCensusIdStringID of the group census. Required when you update existing group census member details.Optional68.0
personAccountIdsString[]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.Optional68.0
policyEffectiveDateStringDate used to determine the policy version for generating or updating group census member details, in YYYY-MM-DD format. The specified date must fall between the policy version’s effectiveFromDate and effectiveToDate.Optional68.0
policyIdsString[]Policy IDs from which member information is retrieved for the specified contacts or accounts.Optional68.0
shouldGenerateCsvBooleanIndicates whether to create a CSV file with all the census data (true) or not (false).Optional68.0
shouldIncludeMemberPlansBooleanIndicates 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.Optional68.0