Enroll all members of a group census in their selected group benefit insurance plans as
a single asynchronous bulk operation. The API response returns the ID of the bulk request so that
you can track the enrollment job.
Resource
{censusId} is a placeholder.
/connect/insurance/group-censuses/{censusId}/policies
Resource Example
Replace {yourInstance} with the My Domain name of your Salesforce org.
https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/group-censuses/0rlxx000000001aEAA/policies
Available Version
65.0
HTTP Methods
POST
Path Parameter for POST
| Parameter Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| censusId | String | ID of the group census whose members you want to enroll in their selected group benefit plans. | Required | 65.0 |
Request Body for POST
JSON Example
{
"batchJobName": "GroupBenefitsEnrollment_Q1",
"flowName": "MyEnrollmentFlow"
}
Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| batchJobName | String | Name that identifies the asynchronous batch job that enrolls the members of the group census. Use a descriptive value so that you can locate the job later when tracking its status. | Optional | 65.0 |
| flowName | String | API name of an optional custom flow to run for each member as part of the bulk enrollment, endorsement, or renewal process. If you don't specify a value, the default Enroll Member flow is used. | Optional | 68.0 |