Insurance Developer Guide
jGenerate Group Census From Insurance Contract Action
Asynchronously generate a group census containing member and plan configuration from
the active insurance policies associated with an insurance contract.
This action is available in API version 68.0 and later.
Supported REST HTTP Methods
URI: /services/data/v68.0/actions/standard/generateCensus
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer token
Inputs
| Input | Type | Description |
|---|---|---|
| contractId | string | Required. ID of the insurance contract whose details to use to generate group census. |
| insGenerateCensusInputRep | Apex-defined | Required. An Apex ConnectApi.InsuranceGenerateCensusInputRepresentation record that contains the policy details to generate the group census. |
Outputs
| Output | Type | Description |
|---|---|---|
| insGenerateCensusRep | Apex-defined | An Apex ConnectApi.InsuranceGenerateCensusRepresentation record that contains the request ID for the asynchronous process and the ID of the group census record that’s created. |
Example
POST
This sample request is for the Generate Group Census From Insurance Contract action.
1{
2 "inputs": [
3 {
4 "contractId": "800xx0000004C92AAE",
5 "insGenerateCensusInputRep": {
6 "censusName": "Acme Enrollment Census 2026",
7 "censusType": "Enrollment",
8 "policyEffectiveDate": "2026-01-01",
9 "shouldGenerateCsv": true,
10 "shouldIncludeMemberPlans": true,
11 "filter": {
12 "contractGroupPlanIds": [
13 "0gpxx0000000001AAA"
14 ],
15 "objectName": "Contact",
16 "recordIds": [
17 "003xx000004WhKhAAK"
18 ]
19 }
20 }
21 }
22 ]
23}This sample response is for the Generate Group Census From Insurance Contract action.
1[
2 {
3 "actionName": "generateCensus",
4 "errors": null,
5 "invocationId": null,
6 "isSuccess": true,
7 "outcome": null,
8 "outputValues": {
9 "insGenerateCensusRep": {
10 "message": "Census generation started successfully",
11 "groupCensusId": "0rfxx0000004C92AAA",
12 "requestId": "08Pxx0000000001EAA"
13 }
14 },
15 "sortOrder": -1,
16 "version": 1
17 }
18]