Enroll a group census member along with their dependents in the specified group
insurance plan and coverages, creating the necessary policy records (POST). Apply mid-term
adjustment to manage new hires, terminations or benefits changes due to life events, such as
birth, marriage, and promotions (PUT). For both the operations, use the standard flow that manages
person account and contact creation, optional pricing, and policy creation or adjustment, or
provide a custom flow based on your business needs.
Resource
{memberId} is a placeholder.
/connect/insurance/group-census-members/{memberId}/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-census-members/0r6RM0000000h1pYAA/policies
Available Version
POST—65.0PUT—68.0
HTTP Methods
POST, PUT
Path Parameter for POST and PUT
| Parameter Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| memberId | String | ID of the group census member. | Required | 65.0 |
Request Body for POST
JSON Example
{
"flowName": "MyEnrollmentFlow",
"plan": "0gpp00000004C9wAAE",
"shouldReprice": true
}
Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| flowName | String | API name of an optional flow to run as part of the enrollment process.
The default value is Process Group Census Member Data. |
Optional | 65.0 |
| plan | String | ID of the root contract group plan. | Required | 65.0 |
| shouldReprice | Boolean | Indicates whether to recalculate the premiums (true) or not (false). If set to false, the API uses the premiums from the existing Group Census Member Plan records instead of recalculating them. The default value is true. | Optional | 68.0 |
Request Body for PUT
JSON Example
{
"flowName": "MyAdjustmentFlow",
"plans": [
"0gpp00000004C9wAAE"
],
"shouldReprice": true
}
Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| flowName | String | API name of an optional custom flow to run as part of the mid-term adjustment. If
you don't specify a value, the default flow is used.
The default value is Process Group Census Member Data. |
Optional | 68.0 |
| plans | String[] | IDs of the root contract group plans to adjust for the member. If not specified, the API adjusts every plan that the member is currently subscribed to. | Optional | 68.0 |
| shouldReprice | Boolean | Indicates whether to recalculate the premiums (true) or not (false). If set to false, the API uses the premiums from the existing Group Census Member Plan records instead of recalculating them. The default value is true. | Optional | 68.0 |