Update Group Census (PATCH)

Update a group census from policy enrollments and endorsements on an existing group benefits contract for a specified date range. This API runs asynchronously and returns a request ID that you can use to track the job or retry a failed run.

Resource

{contractId} is a placeholder.

1/connect/insurance/contracts/{contractId}/actions/refresh-census

Resource Example

Replace {yourInstance} with the My Domain name of your Salesforce org.

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/contracts/800xx0000004C92AAE/actions/refresh-census

Available Version

68.0

HTTP Methods

PATCH

Path Parameter for PATCH

Parameter Name	Type	Description	Required or Optional	Available Version
`contractId`	String	ID of the insurance contract whose policy enrollments and endorsements are used to update the group census.	Required	68.0

Request Body for PATCH

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

Name	Type	Description	Required or Optional	Available Version
`endDate`	String	End 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.	Required	68.0
`filter`	Insurance Census Filter Input	Filter 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.	Optional	68.0
`groupCensusAdditionalFields`	Apex String[]	Key-value pairs of additional group census member field values to update. Each entry contains a field API name and value.	Optional	68.0
`groupCensusId`	String	ID of the group census record to update.	Required	68.0
`policyEffectiveDate`	String	Date 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`.	Required	68.0
`requestId`	String	ID 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 run	68.0
`shouldGenerateCSV`	Boolean	Indicates whether to create a CSV file with the updated group census details ( `true`) or not ( `false`). The default value is `false`.	Optional	68.0
`shouldIncludeMemberPlans`	Boolean	Indicates whether to include plan details for the members when updating the group census ( `true`) or not ( `false`). The default value is `false`.	Optional	68.0
`startDate`	String	Start 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.	Required	68.0

Response Body for PATCH

Update Group Census Response