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/vXX.X/actions/standard/refreshCensus

Where XX.X is the latest API version.

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

Inputs

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

Outputs

Output	Type	Description
insRefreshCensusRep	Apex-defined	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.

{
  "inputs": [
    {
      "contractId": "800xx0000004C92AAE",
      "insRefreshCensusInputRep": {
        "groupCensusId": "0rfxx0000004C92AAA",
        "startDate": "2026-01-01",
        "endDate": "2026-03-31",
        "policyEffectiveDate": "2026-01-01",
        "shouldGenerateCSV": true,
        "shouldIncludeMemberPlans": true,
        "groupCensusAdditionalFields": [
          {
            "key": "Status__c",
            "value": "Active"
          }
        ],
        "filter": {
          "contractGroupPlanIds": [
            "0gpxx0000000001AAA"
          ],
          "objectName": "Contact",
          "recordIds": [
            "003xx000004WhKhAAK"
          ]
        }
      }
    }
  ]
}

This sample response is for the Update Group Census action.

[
  {
    "actionName": "refreshCensus",
    "errors": null,
    "invocationId": null,
    "isSuccess": true,
    "outcome": null,
    "outputValues": {
      "insRefreshCensusRep": {
        "message": "Census generation started successfully",
        "groupCensusId": "0rfxx0000004C92AAA",
        "requestId": "08Pxx0000000001EAA"
      }
    },
    "sortOrder": -1,
    "version": 1
  }
]