Group Enrollment (POST)
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
-
1/connect/insurance/group-censuses/censusId/policies - Resource example
-
1https://yourInstance.salesforce.com/services/data/v67.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
-
1{ 2 "batchJobName": "GroupBenefitsEnrollment_Q1", 3 "flowName": "MyEnrollmentFlow" 4} - 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
- Response body for POST
- Group Enrollment Response