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 

{censusId} is a placeholder.

1/connect/insurance/group-censuses/{censusId}/policies

Resource Example 

Replace {yourInstance} with the My Domain name of your Salesforce org.

1https://{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 NameTypeDescriptionRequired or OptionalAvailable Version
censusIdStringID of the group census whose members you want to enroll in their selected group benefit plans.Required65.0

Request Body for POST 

JSON Example 

1{
2  "batchJobName": "GroupBenefitsEnrollment_Q1",
3  "flowName": "MyEnrollmentFlow"
4}

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
batchJobNameStringName 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.Optional65.0
flowNameStringAPI 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.Optional68.0

Response Body for POST 

Group Enrollment Response