Update Group Census Input

Input representation of the details to update a group census from policy enrollments and endorsements on an existing group benefits contract.

JSON Example 

1{
2  "groupCensusId": "0rfxx0000004C92AAA",
3  "startDate": "2026-01-01",
4  "endDate": "2026-03-31",
5  "policyEffectiveDate": "2026-01-01",
6  "shouldGenerateCSV": true,
7  "shouldIncludeMemberPlans": true,
8  "groupCensusAdditionalFields": [
9    {
10      "key": "Status__c",
11      "value": "Active"
12    }
13  ],
14  "filter": {
15    "contractGroupPlanIds": [
16      "0gpxx0000000001AAA"
17    ],
18    "objectName": "Contact",
19    "recordIds": [
20      "003xx000004WhKhAAK"
21    ]
22  }
23}

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
endDateStringEnd date of the time period that’s used to find policy enrollments and endorsements that update the group census and associated records. Specify the date in YYYY-MM-DD format.Required68.0
filterInsurance Census Filter InputFilter criteria that identify which policy records associated with the insurance contract to include when updating the group census. You can filter by root contract group plan IDs, Person Accounts, and Contacts.Optional68.0
groupCensusAdditionalFieldsApex String[]Key-value pairs of additional group census member field values to update. Each entry contains a field API name and value.Optional68.0
groupCensusIdStringID of the group census record to update.Required68.0
policyEffectiveDateStringDate that’s used to determine the policy version for updating member and plan configuration details, in YYYY-MM-DD format. The specified date must fall between the policy version’s effectiveFromDate and effectiveToDate.Required68.0
requestIdStringID of the asynchronous request from a previous run. Use with groupCensusId to retry updating the records that failed in a previous run.Required to rerun the asynchronous job to update a group census that failed in a previous run68.0
shouldGenerateCSVBooleanIndicates whether to create a CSV file with the updated group census details (true) or not (false). The default value is false.Optional68.0
shouldIncludeMemberPlansBooleanIndicates whether to include plan details for the members when updating the group census (true) or not (false). The default value is false.Optional68.0
startDateStringStart date of the time period that’s used to find policy enrollments and endorsements that update the group census and associated records. Specify the date in YYYY-MM-DD format.Required68.0