Insurance Developer Guide

Get Started with Insurance Developer Resources
Insurance Brokerage
Insurance Claims Management
Insurance Group Benefits
Insurance Group Benefits Business APIs
Resources
Insurance Person Accounts and Users (POST)
Insurance Contacts and Users (POST)
Insurance Member Rating (POST)
Insurance Group Census Members (POST, PATCH, DELETE)
Insurance Group Census Members Delete (POST)
Insurance Bulk Census Management (POST)
Insurance Census Summary Sync (POST)
Insurance Member Plans (POST, PATCH)
Insurance Member Plans Delete (POST)
Insurance Member Eligible Plans (GET)
Insurance Plans Eligibility Check (POST, PATCH)
Insurance Contract from Quote (POST)
Insurance Group Rating (POST)
Individual Enrollment (POST)
Group Enrollment (POST)
Requests
Responses
Insurance Group Benefits Apex Reference
Insurance Group Benefits Standard Invocable Actions
Insurance Group Benefits Metadata API Types
Insurance Policy Administration
Insurance Product Administration
Insurance Quoting
Insurance Apex Reference
Error Codes and Responses
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

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/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
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