Generate Census Information from Policies for Contract (POST)

Generate a group census along with member and optional plan configuration from the active policies on an existing group benefits contract. You can optionally filter based on contract group plans, contacts, or person accounts. 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/generate-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/generate-census

Available Version

68.0

HTTP Methods

POST

Path Parameter for POST

Parameter Name	Type	Description	Required or Optional	Available Version
`contractId`	String	ID of the insurance contract whose policies are used to generate the group census.	Required	68.0

Request Body for POST

JSON Example

1{
2  "shouldGenerateCSV": true,
3  "shouldIncludeMemberPlans": true,
4  "filter": {
5    "contractGroupPlanIds": {
6      "values": [
7        "0rgVW00000001tlYAA"
8      ]
9    },
10    "objectName": "Contact",
11    "recordIds": {
12      "values": [
13        "003VW00000BcBIfYAN"
14      ]
15    }
16  }
17}

Properties

Name	Type	Description	Required or Optional	Available Version
`censusName`	String	Name of the group census to create.	Optional	68.0
`censusType`	String	Type of group census to generate, such as Enrollment or Quote.	Required	68.0
`filter`	Insurance Census Filter Input	Filter criteria that indicate which policy records to include when generating the group census. You can filter by root contract group plan IDs, Person Accounts, and Contacts.	Optional	68.0
`policyEffectiveDate`	String	Date used to determine the policy version for generating the group census, in YYYY-MM-DD format. The specified date must fall between the policy version’s `effectiveFromDate` and `effectiveToDate`.	Optional	68.0
`requestId`	String	ID of the asynchronous request from a previous run.	Required when you regenerate a group census that failed in the previous run.	68.0
`shouldGenerateCSV`	Boolean	Indicates whether to create a CSV file with all the census details (`true`) or not (`false`).	Optional	68.0
`shouldIncludeMemberPlans`	Boolean	Indicates whether to include insurance plan details for each member in the generated group census (`true`) or not (`false`).	Optional	68.0

Response Body for POST

Insurance Generate Census Response