Update Group Census Action

Asynchronously update a group census using the insurance contract data. Specify the date range, and the API updates the group census member and plan configuration details based on the policy enrollments or adjustments during the specified time period.

This action is available in API version 68.0 and later.

Supported REST HTTP Methods

URI: /services/data/v68.0/actions/standard/refreshCensus
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearertoken

Inputs

Input	Details
contractId	Type string Description Required. ID of the insurance contract whose details to use to update the group census.
insRefreshCensusInputRep	Type Apex-defined Description Required. An Apex `ConnectApi.InsuranceRefreshCensusInputRepresentation` record that contains the configuration details for updating a group census.

Outputs

Output	Details
insRefreshCensusRep	Type Apex-defined Description An Apex `ConnectApi.InsuranceRefreshCensusRepresentation` record that contains the asynchronous request ID and the ID of the group census record that’s updated.

Example

POST

This sample request is for the Update Group Census action.

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

This sample response is for the Update Group Census action.

1[
2  {
3    "actionName": "refreshCensus",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outcome": null,
8    "outputValues": {
9      "insRefreshCensusRep": {
10        "message": "Census generation started successfully",
11        "groupCensusId": "0rfxx0000004C92AAA",
12        "requestId": "08Pxx0000000001EAA"
13      }
14    },
15    "sortOrder": -1,
16    "version": 1
17  }
18]

Insurance Developer Guide

Update Group Census Action

Supported REST HTTP Methods

Inputs

Outputs

Example